Render API reference documentation

Now that we're starting to commit code to the repository
and build out an API, we should start generating documentation for
it.

Change-Id: I20e9d3155331c08cc3817c17c183e80a89235b7f

doc/requirements.txt

@@ -4,3 +4,4 @@
 openstackdocstheme>=1.20.0 # Apache-2.0
 reno>=2.5.0 # Apache-2.0
 sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD
+sphinxcontrib-apidoc>=0.2.0  # BSD

doc/source/conf.py

@@ -18,9 +18,15 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
-    'openstackdocstheme'
+    'openstackdocstheme',
+    'sphinxcontrib.apidoc'
 ]
 
+apidoc_module_dir = '../../oslo_limit'
+apidoc_excluded_paths = ['tests']
+apidoc_output_dir = 'reference/api'
+apidoc_separate_modules = True
+
 # The suffix of source filenames.
 # source_suffix = '.rst'
 

doc/source/reference/index.rst

@@ -2,11 +2,6 @@
 oslo.limit API Reference
 ========================
 
-.. Use autodoc directives to describe the *public* modules and classes
-   in the library.
+.. toctree::
 
-   If the modules are completely unrelated, create an api subdirectory
-   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).
+   api/modules

setup.cfg

@@ -41,4 +41,4 @@ mapping_file = babel.cfg
 output_file = oslo_limit/locale/oslo_limit.pot
 
 [wheel]
-universal = true
+universal = true