summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/conf.py12
-rw-r--r--doc/source/index.rst9
-rw-r--r--doc/source/reference/index.rst2
3 files changed, 18 insertions, 5 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 0f7099a..6233623 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -28,12 +28,22 @@ sys.path.insert(0, ROOT)
sys.path.insert(0, BASE_DIR)
extensions = [
- 'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.coverage',
'openstackdocstheme',
+ 'sphinxcontrib.apidoc',
]
+# sphinxcontrib.apidoc options
+apidoc_module_dir = '../../troveclient'
+apidoc_output_dir = 'reference/api'
+apidoc_excluded_paths = [
+ 'compat/tests/*',
+ 'compat/tests',
+ 'tests/*',
+ 'tests']
+apidoc_separate_modules = True
+
# openstackdocstheme options
repository_name = 'openstack/python-troveclient'
bug_project = 'python-troveclient'
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 22b0459..9b3e989 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -11,14 +11,17 @@
License for the specific language governing permissions and limitations
under the License.
-============================================
+===========================================
Python bindings to the OpenStack Trove API
-============================================
+===========================================
This is a client for the OpenStack Trove API. There's a Python API (the
``troveclient`` module), and a command-line script (``trove``). Each
implements 100% of the OpenStack Trove API.
+Contents
+--------
+
.. toctree::
:maxdepth: 2
@@ -27,7 +30,7 @@ implements 100% of the OpenStack Trove API.
reference/index
Indices and tables
-==================
+------------------
* :ref:`genindex`
* :ref:`search`
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
index 1d9e914..efc5e39 100644
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@@ -5,4 +5,4 @@
.. toctree::
:maxdepth: 2
- api/autoindex
+ api/modules