Add API auto-generation based on docstrings

We've been adding docstrings, maybe we should put them into our
documentation.

Change-Id: I11ee33e1b87854403ec8b4e35f338c2c604d7fa4
This commit is contained in:
Monty Taylor 2015-04-02 13:48:10 -04:00
parent 8c3601474b
commit 5ca933aa7f
5 changed files with 10 additions and 5 deletions

View File

@ -3,6 +3,8 @@ import sys
sys.path.insert(0, os.path.abspath('../..'))
extensions = ['sphinx.ext.autodoc', 'oslosphinx']
# The suffix of source filenames.
source_suffix = '.rst'

View File

@ -11,11 +11,12 @@ Contents:
.. toctree::
:maxdepth: 2
readme
installation
usage
contributing
.. include:: ../../README.rst
Indices and tables
==================

View File

@ -1 +0,0 @@
.. include:: ../README.rst

View File

@ -4,4 +4,7 @@ Usage
To use shade in a project::
import shade
import shade
.. automodule:: shade
:members:

View File

@ -5,8 +5,8 @@ discover
fixtures>=0.3.14
mock>=1.0
python-subunit
sphinx>=1.1.2
oslo.sphinx
oslosphinx>=2.2.0 # Apache-2.0
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
testrepository>=0.0.17
testscenarios>=0.4,<0.5
testtools>=0.9.32