Prepare for documentation of Resources

Add a section for where Resource classes will show up in the docs and
enter two skeleton pages for how this will look. Later changes will
cover the actual member-level documentation of the Resource classes for
each service, along with their addition to the TOC.

This additionally sets autodoc_member_order globally to "bysource",
meaning it'll order the rendered member documentation in the order it
was written. The default of alphabetical order by what shows up in
__dir__ is not as helpful or as readable as how we've organized the code.

Change-Id: Ifcd7cd81ba55ecb429c50680a926d4f8a44ca9a3
This commit is contained in:
Brian Curtin 2014-11-24 13:49:21 -06:00
parent a217ea3183
commit b0a65514c0
4 changed files with 33 additions and 2 deletions

View File

@ -50,6 +50,8 @@ add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
autodoc_member_order = "bysource"
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with

View File

@ -11,8 +11,17 @@ Welcome!
contributing
glossary
Classes
-------
Resource Level Classes
----------------------
.. toctree::
:maxdepth: 1
resources/object_store/v1/container
resources/object_store/v1/obj
Low-Level Classes
-----------------
.. toctree::
:maxdepth: 1

View File

@ -0,0 +1,10 @@
openstack.object_store.v1.container
===================================
.. automodule:: openstack.object_store.v1.container
The Container Class
-------------------
.. autoclass:: openstack.object_store.v1.container.Container
:members:

View File

@ -0,0 +1,10 @@
openstack.object_store.v1.obj
=============================
.. automodule:: openstack.object_store.v1.obj
The Object Class
----------------
.. autoclass:: openstack.object_store.v1.obj.Object
:members: