laforge has submitted this change. ( https://gerrit.osmocom.org/c/pysim/+/33250 )
Change subject: Add ".py" suffix to sphinx-argparse generated docs ......................................................................
Add ".py" suffix to sphinx-argparse generated docs
This is important to produce the right command syntax when generating command line reference in the user manual. However, we shouldn't add this kludge to the individual programs, but only to the documentation using the :prog: syntax.
Change-Id: I2ec7ab00c63d5d386f187e54755c71ffc2dce429 --- M docs/legacy.rst M docs/shell.rst M pySim-read.py M pySim-shell.py 4 files changed, 18 insertions(+), 3 deletions(-)
Approvals: Jenkins Builder: Verified laforge: Looks good to me, approved
diff --git a/docs/legacy.rst b/docs/legacy.rst index d93358f..0961d17 100644 --- a/docs/legacy.rst +++ b/docs/legacy.rst @@ -98,3 +98,4 @@ .. argparse:: :module: pySim-read :func: option_parser + :prog: pySim-read.py diff --git a/docs/shell.rst b/docs/shell.rst index e13d054..ef08fcf 100644 --- a/docs/shell.rst +++ b/docs/shell.rst @@ -35,6 +35,7 @@ .. argparse:: :module: pySim-shell :func: option_parser + :prog: pySim-shell.py
Usage Examples -------------- diff --git a/pySim-read.py b/pySim-read.py index ddc193a..f80509c 100755 --- a/pySim-read.py +++ b/pySim-read.py @@ -40,8 +40,7 @@ from pySim.utils import format_xplmn_w_act, dec_st from pySim.utils import h2s, format_ePDGSelection
-option_parser = argparse.ArgumentParser(prog='pySim-read', - description='Legacy tool for reading some parts of a SIM card', +option_parser = argparse.ArgumentParser(description='Legacy tool for reading some parts of a SIM card', formatter_class=argparse.ArgumentDefaultsHelpFormatter) argparse_add_reader_args(option_parser)
diff --git a/pySim-shell.py b/pySim-shell.py index 3f0818a..c6782d4 100755 --- a/pySim-shell.py +++ b/pySim-shell.py @@ -949,7 +949,7 @@
-option_parser = argparse.ArgumentParser(prog='pySim-shell', description='interactive SIM card shell', +option_parser = argparse.ArgumentParser(description='interactive SIM card shell', formatter_class=argparse.ArgumentDefaultsHelpFormatter) argparse_add_reader_args(option_parser)