catarrh/pysim
1
0
Fork 0
mirror of https://gitea.osmocom.org/sim-card/pysim.git synced 2026-03-20 04:18:36 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs/shell.rst: Auto-generate shell command reference

Browse Source 
We use a slightly modified version of sphinx-argparse
(with patch https://github.com/alex-rudakov/sphinx-argparse/pull/136 applied)
in order to generate the command reference for each shell command in the
manual.

As the upstream repository seems unmaintained for ~2 years, let's use
the osmocom 'fork' with that above-mentioned patch applied.

Change-Id: I134f267cf53c7ecbc8cbfb33a8766d63bf4a8582
This commit is contained in:
Harald Welte
2021-04-04 14:37:55 +02:00
parent 1748b9372c
commit d36f6943d9
3 changed files with 58 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
contrib/jenkins.sh
View File

@@ -21,6 +21,7 @@ python -m unittest discover -v -s tests/
# attempt to build documentation
pip install sphinx
pip install sphinxcontrib-napoleon
pip3 install -e 'git+https://github.com/osmocom/sphinx-argparse@master#egg=sphinx-argparse'
(cd docs && make html)
# run the test with physical cards