From d71a08eeac379ea5d4b0ea759c5118e59e8ff78b Mon Sep 17 00:00:00 2001
From: Nate Potter <nathaniel.potter@intel.com>
Date: Tue, 19 Sep 2017 13:44:39 -0700
Subject: [PATCH] Add python API to doc

Update the documentation to include a generated python
module index detailing the python API for the project.

Change-Id: I3a0b54ca96f95ec84c17348f3821250fb630b842
---
 .gitignore                     |  1 +
 README.rst                     |  2 +-
 doc/source/reference/index.rst | 30 ++++++++++++++++++++++++++----
 setup.cfg                      |  6 ++++++
 4 files changed, 34 insertions(+), 5 deletions(-)

diff --git a/.gitignore b/.gitignore
index c4876b9..be03b95 100644
--- a/.gitignore
+++ b/.gitignore
@@ -45,6 +45,7 @@ output/*/index.html
 
 # Sphinx
 doc/build
+doc/source/reference/api
 
 # pbr generates these
 AUTHORS
diff --git a/README.rst b/README.rst
index 826ee6b..47fab37 100644
--- a/README.rst
+++ b/README.rst
@@ -10,6 +10,6 @@ node composition and decomposition, remote storage discovery and composition,
 and NVMe over PCIe drive attaching and detaching to logical nodes.
 
 * Free software: Apache license
-* Documentation: http://docs.openstack.org/developer/rsd-lib
+* Documentation: http://docs.openstack.org/rsd-lib/latest
 * Source: http://git.openstack.org/cgit/openstack/rsd-lib
 * Bugs: http://bugs.launchpad.net/https://launchpad.net/python-rsdclient
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
index d32c1f8..3bd35d4 100644
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@@ -1,10 +1,32 @@
-==========
-References
-==========
+======================
+RSD Library References
+======================
 
-References of rsd-lib.
+Features
+========
+
+* Existing sushy library functionality abstracting system
+  resources
+* Enablement of node composition services via Rack Scale Design
+  enabled hardware.
+* Abstraction of composed node, remote storage, and NVMe device
+  resources, including identification and asset information.
+* Composed node power management.
+* Changing nodes boot device, frequency, and mode.
+* Attaching/Detaching of NVMe devices to existing composed nodes.
 
 .. toctree::
    :maxdepth: 2
 
    usage
+
+RSD-Lib Python API Reference
+============================
+
+* :ref:`modindex`
+
+.. # api/autoindex is hidden since it's in the modindex link above.
+.. toctree::
+  :hidden:
+
+  api/autoindex
diff --git a/setup.cfg b/setup.cfg
index 8daf2ad..0353ad7 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -45,3 +45,9 @@ input_file = rsd_lib/locale/rsd_lib.pot
 keywords = _ gettext ngettext l_ lazy_gettext
 mapping_file = babel.cfg
 output_file = rsd_lib/locale/rsd_lib.pot
+
+[pbr]
+autodoc_index_modules = True
+api_doc_dir = reference/api
+autodoc_exclude_modules =
+    rsd_lib.tests.*