Publish native Doxygen documentation with GitHub Pages - #3059
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Publish the CLI reference at https://shadowsocks.github.io/shadowsocks-c/ and rebuild it automatically after updates to master. The documentation workflow validates pull requests, uploads Doxygen HTML only from the canonical master branch, and deploys through the github-pages environment with scoped Pages/OIDC permissions. Manual master deployments are supported. The published site links to a downloadable man-pages.tar.gz archive containing all six CLI manuals and both overview names.
Migrate the pending documentation work to native Doxygen snippets and Markdown pages, replacing the custom generator and AsciiDoc/xmlto pipeline. Retain parser-versus-documentation validation, conventional man-page names, and the legacy overview alias. Update Debian dependencies and contribution instructions.
Validation: local workflow/Python lint; 10 documentation regression tests; all 35 CTest tests; 131 setup assertions; three 10 MB cipher stress tests; complete Doxygen HTML/man rendering; rendered flag coverage and installation paths; unchanged ss-nat help output; documentation rendering with Python discovery disabled. GitHub Pages has been configured to use GitHub Actions; the first public deployment will run after merge.