diff options
Diffstat (limited to '')
-rw-r--r-- | doc/man/sphinx-apidoc.rst | 26 |
1 files changed, 16 insertions, 10 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``) |