sim-card
/
pysim
mirror of https://gerrit.osmocom.org/pysim
10
0
Fork 1
Code Issues Releases Wiki Activity

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
This commit is contained in:
Harald Welte 2023-06-09 11:15:09 +02:00
parent f9a5ba5e0f
commit f422eb1886
4 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/legacy.rst
View File

@ -98,3 +98,4 @@ pySim-read usage
.. argparse::
:module: pySim-read
:func: option_parser
:prog: pySim-read.py

1
docs/shell.rst
View File

@ -35,6 +35,7 @@ pySim-shell has a variety of command line arguments to control
.. argparse::
:module: pySim-shell
:func: option_parser
:prog: pySim-shell.py
Usage Examples
--------------

3
pySim-read.py
View File

@ -40,8 +40,7 @@ from pySim.utils import h2b, swap_nibbles, rpad, dec_imsi, dec_iccid, dec_msisdn
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)

2
pySim-shell.py
View File

@ -949,7 +949,7 @@ class Proact(ProactiveHandler):
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)