openstack/openstacksdk
Code Issues Proposed changes

Add API auto-generation based on docstrings

Browse Source 
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

2
doc/source/conf.py

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

3
doc/source/index.rst

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

1
doc/source/readme.rst

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

5
doc/source/usage.rst

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

4
test-requirements.txt

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