Module docs
The public modules weren't referenced anywhere so the auto-generated module docs weren't generated. Partial-Bug: 1469831 Change-Id: Ic4eaf1fc809d084f79ed9efc494830c5dca3a2cf
This commit is contained in:
parent
80c40f88f1
commit
448c69157c
@ -2,11 +2,8 @@
|
|||||||
API
|
API
|
||||||
=====
|
=====
|
||||||
|
|
||||||
.. Use autodoc directives to describe the *public* modules and classes
|
.. automodule:: oslo_cache.core
|
||||||
in the library.
|
:members:
|
||||||
|
|
||||||
If the modules are completely unrelated, create an api subdirectory
|
.. automodule:: oslo_cache.exception
|
||||||
and use a separate file for each (see oslo.utils).
|
:members:
|
||||||
|
|
||||||
If there is only one submodule, a single api.rst file like this
|
|
||||||
sufficient (see oslo.i18n).
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user