Skip to content

Commit 8f7d38a

Browse files
itsmooshstephenfin
authored andcommitted
Added description of apidoc_template_dir option to README
1 parent 6a66181 commit 8f7d38a

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,15 @@ The *apidoc* extension uses the following configuration values:
5858

5959
**Optional**, defaults to ``api``.
6060

61+
``apidoc_template_dir``
62+
A directory containing user-defined templates. Template files in this
63+
directory that match the default apidoc templates (``module.rst_t``,
64+
``package.rst_t``, ``toc.rst_t``) will overwrite them. The default templates
65+
can be found in ``site-packages/sphinx/templates/apidoc/``. This path is
66+
relative to the documentation source directory.
67+
68+
**Optional**, defaults to ``templates``.
69+
6170
``apidoc_excluded_paths``
6271
An optional list of modules to exclude. These should be paths relative to
6372
``apidoc_module_dir``. fnmatch-style wildcarding is supported.

0 commit comments

Comments
 (0)