diff options
| author | Davanum Srinivas <dims@linux.vnet.ibm.com> | 2014-11-17 17:28:19 -0500 |
|---|---|---|
| committer | Davanum Srinivas <dims@linux.vnet.ibm.com> | 2014-11-19 08:24:08 -0500 |
| commit | 30b096448f173cc24619c8e3499ec142c69f5e0d (patch) | |
| tree | 75e0ac710b5b344e99ce087dfa70ff009da88b76 | |
| parent | f6365e37f552caf8ae562bd17253be15b9663fa2 (diff) | |
| download | oslo-context-30b096448f173cc24619c8e3499ec142c69f5e0d.tar.gz | |
Generate better documentation for the module
Change-Id: Ibad798b09ac1227065173b3b1843cc3b6bfbaf80
| -rw-r--r-- | doc/source/api.rst | 12 | ||||
| -rw-r--r-- | doc/source/api/autoindex.rst | 5 | ||||
| -rw-r--r-- | doc/source/api/oslo_context.context.rst | 7 | ||||
| -rw-r--r-- | doc/source/api/oslo_context.tests.test_context.rst | 7 | ||||
| -rw-r--r-- | doc/source/index.rst | 17 | ||||
| -rw-r--r-- | doc/source/installation.rst | 11 | ||||
| -rw-r--r-- | doc/source/readme.rst | 1 |
7 files changed, 40 insertions, 20 deletions
diff --git a/doc/source/api.rst b/doc/source/api.rst deleted file mode 100644 index 971225e..0000000 --- a/doc/source/api.rst +++ /dev/null @@ -1,12 +0,0 @@ -===== - API -===== - -.. Use autodoc directives to describe the *public* modules and classes - in the library. - - 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). diff --git a/doc/source/api/autoindex.rst b/doc/source/api/autoindex.rst new file mode 100644 index 0000000..eaaf790 --- /dev/null +++ b/doc/source/api/autoindex.rst @@ -0,0 +1,5 @@ +.. toctree:: + :maxdepth: 1 + + oslo_context.context.rst + oslo_context.tests.test_context.rst diff --git a/doc/source/api/oslo_context.context.rst b/doc/source/api/oslo_context.context.rst new file mode 100644 index 0000000..d9ddf35 --- /dev/null +++ b/doc/source/api/oslo_context.context.rst @@ -0,0 +1,7 @@ +The :mod:`oslo_context.context` Module +====================================== + +.. automodule:: oslo_context.context + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/api/oslo_context.tests.test_context.rst b/doc/source/api/oslo_context.tests.test_context.rst new file mode 100644 index 0000000..0c79f3f --- /dev/null +++ b/doc/source/api/oslo_context.tests.test_context.rst @@ -0,0 +1,7 @@ +The :mod:`oslo_context.tests.test_context` Module +================================================= + +.. automodule:: oslo_context.tests.test_context + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/index.rst b/doc/source/index.rst index 8216fb0..338de21 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,24 +2,31 @@ oslo.context ============== -oslo.context library +Welcome to oslo.context's documentation! +======================================== -Contents -======== +Contents: .. toctree:: :maxdepth: 2 + readme installation - api usage contributing history +Code Documentation +================== + +.. toctree:: + :maxdepth: 1 + + api/autoindex + Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` - diff --git a/doc/source/installation.rst b/doc/source/installation.rst index fa0c325..d268650 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -1,7 +1,12 @@ -============== - Installation -============== +============ +Installation +============ At the command line:: $ pip install oslo.context + +Or, if you have virtualenvwrapper installed:: + + $ mkvirtualenv oslo.context + $ pip install oslo.context
\ No newline at end of file diff --git a/doc/source/readme.rst b/doc/source/readme.rst new file mode 100644 index 0000000..a6210d3 --- /dev/null +++ b/doc/source/readme.rst @@ -0,0 +1 @@ +.. include:: ../../README.rst |