From 5ca933aa7f0959f478dafeeebd2d3695d4026d0a Mon Sep 17 00:00:00 2001 From: Monty Taylor Date: Thu, 2 Apr 2015 13:48:10 -0400 Subject: [PATCH] Add API auto-generation based on docstrings We've been adding docstrings, maybe we should put them into our documentation. Change-Id: I11ee33e1b87854403ec8b4e35f338c2c604d7fa4 --- doc/source/conf.py | 2 ++ doc/source/index.rst | 3 ++- doc/source/readme.rst | 1 - doc/source/usage.rst | 5 ++++- test-requirements.txt | 4 ++-- 5 files changed, 10 insertions(+), 5 deletions(-) delete mode 100644 doc/source/readme.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 97d3c2ff4..bbebf4729 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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' diff --git a/doc/source/index.rst b/doc/source/index.rst index e8b236528..15a603f40 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,11 +11,12 @@ Contents: .. toctree:: :maxdepth: 2 - readme installation usage contributing +.. include:: ../../README.rst + Indices and tables ================== diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index 6b2b3ec68..000000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../README.rst \ No newline at end of file diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 96c1020df..75dfc88ae 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -4,4 +4,7 @@ Usage To use shade in a project:: - import shade \ No newline at end of file + import shade + +.. automodule:: shade + :members: diff --git a/test-requirements.txt b/test-requirements.txt index 6957d91b4..b6a09015e 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -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