code-py

Author: AA-Turner

doc/usage/extensions/apidoc.rst

@@ -73,46 +73,46 @@ The apidoc extension uses the following configuration values:
 
    Valid keys are:
 
-   :code-py:`'destination'
+   :code-py:`'destination'`
      The output directory for generated files (**required**).
      This must be relative to the source directory,
      and will be created if it does not exist.
 
-   :code-py:`'path'
+   :code-py:`'path'`
      The path to the module to document (**required**).
      This must be absolute or relative to the configuration directory.
 
-   :code-py:`'exclude_patterns'
+   :code-py:`'exclude_patterns'`
      A sequence of patterns to exclude from generation.
      These may be literal paths or :py:mod:`fnmatch`-style patterns.
      Defaults to :code-py:`()`.
 
-   :code-py:`'maxdepth'
+   :code-py:`'maxdepth'`
      The maximum depth of submodules to show in the generated table of contents.
      Defaults to :code-py:`4`.
 
-   :code-py:`'followlinks'
+   :code-py:`'followlinks'`
      Follow symbolic links.
      Defaults to :code-py:`False`.
 
-   :code-py:`'separatemodules'
+   :code-py:`'separatemodules'`
      Put documentation for each module on an individual page.
      Defaults to :code-py:`False`.
 
-   :code-py:`'includeprivate'
+   :code-py:`'includeprivate'`
      Generate documentation for '_private' modules with leading underscores.
      Defaults to :code-py:`False`.
 
-   :code-py:`'noheadings'
+   :code-py:`'noheadings'`
      Do not create headings for the modules/packages.
      Useful when source docstrings already contain headings.
      Defaults to :code-py:`False`.
 
-   :code-py:`'modulefirst'
+   :code-py:`'modulefirst'`
      Place module documentation before submodule documentation.
      Defaults to :code-py:`False`.
 
-   :code-py:`'implicit_namespaces'
+   :code-py:`'implicit_namespaces'`
      By default sphinx-apidoc processes sys.path searching for modules only.
      Python 3.3 introduced :pep:`420` implicit namespaces that allow module path
      structures such as ``foo/bar/module.py`` or ``foo/bar/baz/__init__.py``
@@ -121,6 +121,6 @@ The apidoc extension uses the following configuration values:
      Interpret module paths using :pep:`420` implicit namespaces.
      Defaults to :code-py:`False`.
 
-   :code-py:`'automodule_options'
+   :code-py:`'automodule_options'`
      Options to pass to generated :rst:dir:`automodule` directives.
      Defaults to :code-py:`{'members', 'show-inheritance', 'undoc-members'}`.