Reverse include

go-templates
Eric Holscher 10 years ago
parent 4819dfd3f4
commit 30e473fd9c

@ -1,47 +1 @@
Sphinx Auto API
===============
A tool that generates a full API ref (Javadoc style) for your project.
It requires no RST and is fully automated,
while being integrated into Sphinx.
Install
-------
First you need to install autoapi.
.. code:: bash
pip install sphinx-autoapi
Then add it to your Sphinx project's ``conf.py``:
.. code:: python
extensions = ['autoapi.extension']
autoapi_type = 'python'
autoapi_dir = 'path/to/my/project/files'
autoapi_output = 'path/to/output'
See all available configuration options in :doc:`config`.
Design
------
Read more about the deisgn in our :doc:`design`.
Currently Implemented
---------------------
* Python
* .Net
Future
------
Our goal is to support the following soon:
* Javascript
* PHP
* Python
* Go
.. include:: docs/index.rst
Loading…
Cancel
Save