Show the command line arguments in the documentation

abzer/__main__.py

@@ -21,6 +21,24 @@ def collect_files(dir):
             yield join(dir, dirpath, filename)
 
 
+def make_argparser():
+    parser = argparse.ArgumentParser(prog="abzer",
+                                     formatter_class=argparse.ArgumentDefaultsHelpFormatter)  # noqa
+    parser.add_argument("filenames", metavar="FILENAME", nargs="+")
+    parser.add_argument("-c", "--config",
+                        help="The path to the config file.",
+                        default=const.DEFAULT_CONFIG_PATH)
+    parser.add_argument("-p", "--processes",
+                        help="The number of processes to use for analyzing files.",  # noqa
+                        default=cpu_count(),
+                        type=int)
+    parser.add_argument("-v", "--verbose",
+                        help="Be more verbose.",
+                        action="store_true",
+                        default=False)
+    return parser
+
+
 def read_config(filename):
     """
     :param filename:
@@ -39,20 +57,7 @@ def safety_check(config):
 
 
 def main():
-    parser = argparse.ArgumentParser(prog="abzer",
-                                     formatter_class=argparse.ArgumentDefaultsHelpFormatter)  # noqa
-    parser.add_argument("filenames", metavar="FILENAME", nargs="+")
-    parser.add_argument("-c", "--config",
-                        help="The path to the config file.",
-                        default=const.DEFAULT_CONFIG_PATH)
-    parser.add_argument("-p", "--processes",
-                        help="The number of processes to use for analyzing files.",  # noqa
-                        default=cpu_count(),
-                        type=int)
-    parser.add_argument("-v", "--verbose",
-                        help="Be more verbose.",
-                        action="store_true",
-                        default=False)
+    parser = make_argparser()
     args = parser.parse_args()
 
     if args.verbose:

docs/source/conf.py

@@ -26,7 +26,8 @@
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage',
-              'sphinx.ext.viewcode', 'sphinx.ext.intersphinx']
+              'sphinx.ext.viewcode', 'sphinx.ext.intersphinx',
+              'sphinxcontrib.autoprogram']
 sys.path.insert(0, os.path.abspath("../../"))
 from abzer import __version__
 autodoc_default_flags = ["members", "undoc-members", "show-inheritance"]

docs/source/index.rst

@@ -7,6 +7,7 @@ Contents:
    :maxdepth: 2
 
    setup
+   usage
 
 API:
 

docs/source/usage.rst

@@ -0,0 +1,8 @@
+Usage
+=====
+
+Command line options
+--------------------
+
+.. autoprogram:: abzer.__main__:make_argparser()
+   :prog: abzer

setup.py

@@ -22,7 +22,7 @@
       use_scm_version={"write_to": "abzer/version.py"},
       install_requires=["aiohttp"],
       extras_require={
-          'docs': ['sphinx']},
+          'docs': ['sphinx', 'sphinxcontrib-autoprogram']},
       entry_points={
           'console_scripts': ['abzer=abzer.__main__:main']
       }