Close #5602: apidoc: Add ``--templatedir`` option

1 files changed, 24 insertions, 0 deletions

diff --git a/doc/man/sphinx-apidoc.rst b/doc/man/sphinx-apidoc.rst
index aef497e0d..78c0735cb 100644
--- a/doc/man/sphinx-apidoc.rst
+++ b/doc/man/sphinx-apidoc.rst
@@ -126,6 +126,30 @@ These options are used when :option:`--full` is specified:
 
    Sets the project release to put in generated files (see :confval:`release`).
 
+.. rubric:: Project templating
+
+.. versionadded:: 2.2
+   Project templating options for sphinx-apidoc
+
+.. option:: -t, --templatedir=TEMPLATEDIR
+
+   Template directory for template files.  You can modify the templates of
+   sphinx project files generated by apidoc.  Following Jinja2 template
+   files are allowed:
+
+   * ``module.rst_t``
+   * ``package.rst_t``
+   * ``toc.rst_t``
+   * ``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/apidoc`` and ``sphinx/templates/quickstart``)
+
 Environment
 -----------