openstack/oslo.limit
Code Issues Proposed changes

Render API reference documentation

Browse Source 
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
This commit is contained in:
Lance Bragstad 2018-09-17 15:17:51 +00:00
parent 5b5d628431
commit a22aef3e7a
4 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/requirements.txt
View File

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

8
doc/source/conf.py
View File

@ -18,9 +18,15 @@
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [ 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. # The suffix of source filenames.
# source_suffix = '.rst' # source_suffix = '.rst'

9
doc/source/reference/index.rst
View File

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