add sphinx instructions to build API reference docs
Change-Id: I216d6e8ef7afa7c1de47f28a6e33ca0a10975912 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
1
.gitignore
vendored
1
.gitignore
vendored
@@ -53,3 +53,4 @@ ChangeLog
|
||||
|
||||
# reno build
|
||||
releasenotes/build
|
||||
/doc/source/reference/api/
|
||||
|
@@ -2,11 +2,7 @@
|
||||
API
|
||||
=====
|
||||
|
||||
.. Use autodoc directives to describe the *public* modules and classes
|
||||
in the library.
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
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/autoindex
|
||||
|
Reference in New Issue
Block a user