From 6b11c7a632cf27a2fbb7625fb63c4bde7045408a Mon Sep 17 00:00:00 2001 From: Max Lv Date: Sat, 12 Sep 2026 14:55:13 +0800 Subject: [PATCH] Include downloadable man pages in the published documentation --- .github/workflows/pages.yml | 6 ++++++ CONTRIBUTION.md | 3 ++- doc/index.md | 4 ++++ 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 515fbc73..00b217f5 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -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 diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index 6e56a7d5..4f39d86d 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -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. diff --git a/doc/index.md b/doc/index.md index c5769dfa..9beb7a33 100644 --- a/doc/index.md +++ b/doc/index.md @@ -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.