Include downloadable man pages in the published documentation

This commit is contained in:
Max Lv committed 2026-09-12 14:55:13 +08:00
1 parent f5d5bf0be1
commit 6b11c7a632
3 files changed
+12 -1

No files matched your search

+6
View File
@@ -32,6 +32,12 @@ jobs:
cmake --build build-docs --target doc-man doc-html --parallel 2
python3 scripts/check_cli_docs.py --rendered build-docs
test -s build-docs/html/index.html
- name: Package downloadable man pages
run: |
tar -czf build-docs/html/man-pages.tar.gz -C build-docs \
man/ss-local.1 man/ss-server.1 man/ss-tunnel.1 man/ss-redir.1 \
man/ss-manager.1 man/ss-nat.1 man/shadowsocks-c.8 man/shadowsocks-libev.8
tar -tzf build-docs/html/man-pages.tar.gz
- name: Upload GitHub Pages site
if: github.repository == 'shadowsocks/shadowsocks-c' && github.ref == 'refs/heads/master' && github.event_name != 'pull_request'
uses: actions/upload-pages-artifact@v5
+2 -1
View File
@@ -123,7 +123,8 @@ will review the implementation and relevant CI results before merging.
The `documentation` workflow builds and validates Doxygen output on pull requests.
After a push to `master`, it publishes `build-docs/html` through GitHub Pages using
GitHub Actions. You can also run the workflow manually on `master` to redeploy.
GitHub Actions, including a downloadable `man-pages.tar.gz` archive. You can also
run the workflow manually on `master` to redeploy.
Deployment is limited to the canonical repository's `master` branch; pull requests
and forks only validate the documentation. The `github-pages` environment records
the deployed site URL and deployment history.
+4
View File
@@ -10,3 +10,7 @@ source documentation.
- \ref ss-manager "ss-manager: multi-user management"
- \ref ss-nat "ss-nat: NAT setup helper"
- \ref shadowsocks-c "Configuration, examples, and management protocol"
[Download the generated man pages](https://shadowsocks.github.io/shadowsocks-c/man-pages.tar.gz)
from the published site. The archive includes the six CLI manuals and both
overview lookup names.