Archives/sphinx-autoapi
2
0
Fork 0
mirror of https://github.com/readthedocs/sphinx-autoapi synced 2024-11-04 12:00:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

More updating of readme

Browse Source
This commit is contained in:
Eric Holscher 2015-06-07 08:10:26 -07:00
parent 31924ec371
commit 33914e992c
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.rst
View File

@ -69,9 +69,14 @@ Then add it to your Sphinx project's ``conf.py``:
extensions = ['autoapi.extension']
# Document Python Code
autoapi_type = 'python'
autoapi_dir = 'path/to/python/files'
# Or, Document Go Code
autoapi_type = 'go'
autoapi_dir = 'path/to/go/files'
Then in your ``index.rst``, add autoapi to your TOC tree:
.. code:: rst
@ -84,6 +89,9 @@ This is needed because we will be outputting rst files into the ``autoapi`` dire
This adds it into the global TOCTree for your project,
so that it appears in the menus.
We hope to be able to dynamically add items into the TOCTree, and remove this step.
However, it is currently required.
See all available configuration options in :doc:`config`.
Customize