diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2014-11-19 12:05:17 -0500 |
|---|---|---|
| committer | Doug Hellmann <doug@doughellmann.com> | 2014-11-19 12:05:17 -0500 |
| commit | ecac38aa90c5d5d15dafe56bb9c0414c8c757e01 (patch) | |
| tree | f1ae278eeb69b43ddca8b97ca47eb1389c59e81a | |
| parent | fc2d39034b7ed3a5afbb6467302ae1cd431d57ad (diff) | |
| download | oslo-context-ecac38aa90c5d5d15dafe56bb9c0414c8c757e01.tar.gz | |
Documentation cleanup
Tidy up filenames, layout, and other minor issues with the documentation
before our first release.
bp/graduate-oslo-context
Change-Id: Ib284bbdb50f868b232abc050311ddd5a9d9bde15
| -rw-r--r-- | doc/source/api/autoindex.rst | 6 | ||||
| -rw-r--r-- | doc/source/api/context.rst (renamed from doc/source/api/oslo_context.context.rst) | 0 | ||||
| -rw-r--r-- | doc/source/api/fixture.rst (renamed from doc/source/api/oslo_context.fixture.rst) | 0 | ||||
| -rw-r--r-- | doc/source/api/index.rst | 9 | ||||
| -rw-r--r-- | doc/source/api/oslo_context.tests.test_context.rst | 7 | ||||
| -rw-r--r-- | doc/source/index.rst | 10 | ||||
| -rw-r--r-- | doc/source/installation.rst | 5 | ||||
| -rw-r--r-- | doc/source/readme.rst | 1 | ||||
| -rw-r--r-- | doc/source/usage.rst | 2 |
9 files changed, 12 insertions, 28 deletions
diff --git a/doc/source/api/autoindex.rst b/doc/source/api/autoindex.rst deleted file mode 100644 index 1d5d077..0000000 --- a/doc/source/api/autoindex.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. toctree:: - :maxdepth: 1 - - oslo_context.context.rst - oslo_context.fixture.rst - oslo_context.tests.test_context.rst diff --git a/doc/source/api/oslo_context.context.rst b/doc/source/api/context.rst index d9ddf35..d9ddf35 100644 --- a/doc/source/api/oslo_context.context.rst +++ b/doc/source/api/context.rst diff --git a/doc/source/api/oslo_context.fixture.rst b/doc/source/api/fixture.rst index 58ef47f..58ef47f 100644 --- a/doc/source/api/oslo_context.fixture.rst +++ b/doc/source/api/fixture.rst diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst new file mode 100644 index 0000000..a123a00 --- /dev/null +++ b/doc/source/api/index.rst @@ -0,0 +1,9 @@ +================== + oslo.context API +================== + +.. toctree:: + :maxdepth: 1 + + context.rst + fixture.rst diff --git a/doc/source/api/oslo_context.tests.test_context.rst b/doc/source/api/oslo_context.tests.test_context.rst deleted file mode 100644 index 0c79f3f..0000000 --- a/doc/source/api/oslo_context.tests.test_context.rst +++ /dev/null @@ -1,7 +0,0 @@ -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 338de21..86b923f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,16 +1,10 @@ -============== - oslo.context -============== - -Welcome to oslo.context's documentation! -======================================== +.. include:: ../../README.rst Contents: .. toctree:: :maxdepth: 2 - readme installation usage contributing @@ -22,7 +16,7 @@ Code Documentation .. toctree:: :maxdepth: 1 - api/autoindex + api/index Indices and tables ================== diff --git a/doc/source/installation.rst b/doc/source/installation.rst index d268650..0ee7ae1 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -5,8 +5,3 @@ 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 deleted file mode 100644 index a6210d3..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 1118e9a..a1e9e92 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -4,4 +4,4 @@ To use oslo.context in a project:: - from oslo import context + from oslo_context import context |