add sphinx instructions to build API reference docs

Change-Id: I216d6e8ef7afa7c1de47f28a6e33ca0a10975912
Signed-off-by: Doug Hellmann <doug@doughellmann.com>

.gitignore

@@ -53,3 +53,4 @@ ChangeLog
 
 # reno build
 releasenotes/build
+/doc/source/reference/api/

doc/source/reference/index.rst

@@ -2,11 +2,7 @@
  API
 =====
 
-.. Use autodoc directives to describe the *public* modules and classes
+.. toctree::
-   in the library.
+   :maxdepth: 2
 
-   If the modules are completely unrelated, create an api subdirectory
+   api/autoindex
-   and use a separate file for each (see oslo.utils).
-
-   If there is only one submodule, a single api.rst file like this
-   sufficient (see oslo.i18n).

oslo_privsep/priv_context.py

@@ -77,8 +77,8 @@ def init(root_helper=None):
     user id, forking, or anything else "odd".
 
     :param root_helper: List of command and arguments to prefix
-    privsep-helper with, in order to run helper as root.  Note,
+        privsep-helper with, in order to run helper as root.  Note,
-    ignored if context's helper_command config option is set.
+        ignored if context's helper_command config option is set.
     """
 
     if root_helper:

setup.cfg

@@ -22,6 +22,13 @@ classifier =
 packages =
     oslo_privsep
 
+[pbr]
+autodoc_index_modules = True
+api_doc_dir = reference/api
+autodoc_exclude_modules =
+  oslo_privsep.tests.*
+  oslo_privsep._*
+
 [build_sphinx]
 source-dir = doc/source
 build-dir = doc/build