diff options
Diffstat (limited to 'doc/invocation.rst')
| -rw-r--r-- | doc/invocation.rst | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/invocation.rst b/doc/invocation.rst index ce51fe080..436c652f9 100644 --- a/doc/invocation.rst +++ b/doc/invocation.rst @@ -118,6 +118,10 @@ Extension options Enable `sphinx.ext.viewcode` extension. +.. option:: --extensions=EXTENSIONS + + Enable arbitary extensions. + Makefile and Batchfile creation options --------------------------------------- @@ -138,6 +142,32 @@ Makefile and Batchfile creation options .. versionadded:: 1.3 Add various options for sphinx-quickstart invocation. +Project templating +------------------ + +.. option:: -t, --templatedir=TEMPLATEDIR + + Template directory for template files. You can modify the templates of + sphinx project files generated by quickstart. Following Jinja2 template + files are allowed: + + * master_doc.rst_t + * conf.py_t + * Makefile_t + * Makefile.new_t + * make.bat_t + * make.bat.new_t + + In detail, please refer the system template files Sphinx provides. + (sphinx/templates/quickstart) + +.. option:: -d NAME=VALUE + + Define a template variable + +.. versionadded:: 1.5 + Project templating options for sphinx-quickstart + Invocation of sphinx-build ========================== @@ -453,11 +483,24 @@ The :program:`sphinx-apidoc` script has several options: to default values, but you can influence the most important ones using the following options. +.. option:: --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`` + (notice that ``bar`` and ``foo`` are namespaces, not modules). + + Specifying this option interprets paths recursively according to PEP-0420. + .. option:: -M This option makes sphinx-apidoc put module documentation before submodule documentation. +.. option:: -a + + Append module_path to sys.path. + .. option:: -H project Sets the project name to put in generated files (see :confval:`project`). |