Skip to content

Commit

Permalink
Make template override docs more clear
Browse files Browse the repository at this point in the history
Closes #198
  • Loading branch information
AWhetter committed May 15, 2020
1 parent 2f87d5e commit e8326cb
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.rst
Expand Up @@ -14,6 +14,8 @@ Features

Bug Fixes
^^^^^^^^^
* `#198 <https://github.com/readthedocs/sphinx-autoapi/issues/198>`:
Documentation describes the required layout for template override directories.

Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
10 changes: 10 additions & 0 deletions docs/how_to.rst
Expand Up @@ -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
-------------------------------
Expand Down

0 comments on commit e8326cb

Please sign in to comment.