mirror of
https://github.com/shadowsocks/shadowsocks-libev.git
synced 2026-10-30 13:13:44 +00:00
Generate CLI manual sections from source option declarations
This commit is contained in:
@@ -26,6 +26,27 @@ jobs:
|
||||
run: actionlint -shellcheck= -pyflakes=
|
||||
- name: Lint Python scripts and tests
|
||||
run: ruff check --select E9,F63,F7,F82 tests scripts
|
||||
- name: Check generated CLI documentation
|
||||
run: |
|
||||
python3 scripts/gen_cli_docs.py --check
|
||||
python3 -m unittest discover -s tests -p test_gen_cli_docs.py
|
||||
|
||||
docs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- name: Install documentation tools
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y --no-install-recommends asciidoc xmlto docbook-xml docbook-xsl
|
||||
- name: Build man pages and HTML from source
|
||||
run: |
|
||||
cmake -S . -B build-docs -DWITH_DOC_MAN=ON -DWITH_DOC_HTML=ON
|
||||
cmake --build build-docs --target doc-man doc-html --parallel 2
|
||||
test -s build-docs/man/ss-local.1
|
||||
test -s build-docs/man/ss-nat.1
|
||||
test -s build-docs/man/shadowsocks-c.8
|
||||
test -s build-docs/html/ss-local.html
|
||||
|
||||
tests:
|
||||
strategy:
|
||||
|
||||
Reference in New Issue
Block a user