mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-10-26 07:00:14 -05:00
Close #5602: apidoc: Add `--templatedir` option
This commit is contained in:
1 parent
301d0d6060
commit
a0b4d09b1b
4 files changed
+59
-20
No files matched your search
@@ -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
|
||||
-----------
|
||||
|
||||
|
||||
Reference in new issue
Block a user