diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 3406c587..29051ed4 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -14,6 +14,8 @@ Features Bug Fixes ^^^^^^^^^ +* `#198 `: + Documentation describes the required layout for template override directories. Trivial/Internal Changes ^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/how_to.rst b/docs/how_to.rst index 96355959..8683e29d 100644 --- a/docs/how_to.rst +++ b/docs/how_to.rst @@ -20,6 +20,16 @@ It can be absolute, or relative to the root of the documentation directory autoapi_template_dir = '_autoapi_templates' +Your template directory must to follow the same layout as the default templates. +For example, to override the Python class and module templates: + +.. code-block:: none + + _autoapi_templates + └── python + ├── class.rst + └── module.rst + How to Customise the Index Page -------------------------------