diff options
Diffstat (limited to '')
-rw-r--r-- | doc/man/sphinx-apidoc.rst | 26 | ||||
-rw-r--r-- | doc/man/sphinx-autogen.rst | 5 | ||||
-rw-r--r-- | doc/man/sphinx-build.rst | 10 | ||||
-rw-r--r-- | doc/man/sphinx-quickstart.rst | 12 |
4 files changed, 33 insertions, 20 deletions
diff --git a/doc/man/sphinx-apidoc.rst b/doc/man/sphinx-apidoc.rst index efc8230..a023b2d 100644 --- a/doc/man/sphinx-apidoc.rst +++ b/doc/man/sphinx-apidoc.rst @@ -54,7 +54,7 @@ Options .. option:: -n, --dry-run - Do not create any files. + Do not create or remove any files. .. option:: -s <suffix> @@ -73,6 +73,12 @@ Options Do not create a table of contents file. Ignored when :option:`--full` is provided. +.. option:: --remove-old + + Remove existing files in the output directory + that are not created anymore. + Not compatible with :option:`--full`. + .. option:: -F, --full Generate a full Sphinx project (``conf.py``, ``Makefile`` etc.) using @@ -142,15 +148,15 @@ These options are used when :option:`--full` is specified: sphinx project files generated by apidoc. Following Jinja2 template files are allowed: - * ``module.rst_t`` - * ``package.rst_t`` - * ``toc.rst_t`` - * ``root_doc.rst_t`` - * ``conf.py_t`` - * ``Makefile_t`` - * ``Makefile.new_t`` - * ``make.bat_t`` - * ``make.bat.new_t`` + * ``module.rst.jinja`` + * ``package.rst.jinja`` + * ``toc.rst.jinja`` + * ``root_doc.rst.jinja`` + * ``conf.py.jinja`` + * ``Makefile.jinja`` + * ``Makefile.new.jinja`` + * ``make.bat.jinja`` + * ``make.bat.new.jinja`` In detail, please refer the system template files Sphinx provides. (``sphinx/templates/apidoc`` and ``sphinx/templates/quickstart``) diff --git a/doc/man/sphinx-autogen.rst b/doc/man/sphinx-autogen.rst index caeb44b..43cc369 100644 --- a/doc/man/sphinx-autogen.rst +++ b/doc/man/sphinx-autogen.rst @@ -43,6 +43,11 @@ Options Document exactly the members in a module's ``__all__`` attribute. +.. option:: --remove-old + + Remove existing files in the output directory + that are not generated anymore. + Example ------- diff --git a/doc/man/sphinx-build.rst b/doc/man/sphinx-build.rst index 8be2780..ac2e7ca 100644 --- a/doc/man/sphinx-build.rst +++ b/doc/man/sphinx-build.rst @@ -102,8 +102,10 @@ Options .. option:: -t tag, --tag tag - Define the tag *tag*. This is relevant for :rst:dir:`only` directives that - only include their content if this tag is set. + Define the tag *tag*. + This is relevant for :rst:dir:`only` directives that + include their content only if certain tags are set. + See :ref:`including content based on tags <tags>` for further detail. .. versionadded:: 0.6 @@ -126,7 +128,7 @@ Options Distribute the build over *N* processes in parallel, to make building on multiprocessor machines more effective. Note that not all parts and not all builders of Sphinx can be parallelized. If ``auto`` argument is given, - Sphinx uses the number of CPUs as *N*. + Sphinx uses the number of CPUs as *N*. Defaults to 1. .. versionadded:: 1.2 This option should be considered *experimental*. @@ -192,7 +194,7 @@ Options .. option:: -n, --nitpicky - Run in nit-picky mode. Currently, this generates warnings for all missing + Run in nitpicky mode. Currently, this generates warnings for all missing references. See the config value :confval:`nitpick_ignore` for a way to exclude some references as "known missing". diff --git a/doc/man/sphinx-quickstart.rst b/doc/man/sphinx-quickstart.rst index cc6673d..a8522ec 100644 --- a/doc/man/sphinx-quickstart.rst +++ b/doc/man/sphinx-quickstart.rst @@ -152,12 +152,12 @@ Options sphinx project files generated by quickstart. Following Jinja2 template files are allowed: - * ``root_doc.rst_t`` - * ``conf.py_t`` - * ``Makefile_t`` - * ``Makefile.new_t`` - * ``make.bat_t`` - * ``make.bat.new_t`` + * ``root_doc.rst.jinja`` + * ``conf.py.jinja`` + * ``Makefile.jinja`` + * ``Makefile.new.jinja`` + * ``make.bat.jinja`` + * ``make.bat.new.jinja`` In detail, please refer the system template files Sphinx provides. (``sphinx/templates/quickstart``) |