Documentation cleanup

Tidy up filenames, layout, and other minor issues with the documentation
before our first release.

bp/graduate-oslo-context

Change-Id: Ib284bbdb50f868b232abc050311ddd5a9d9bde15
This commit is contained in:
Doug Hellmann 2014-11-19 12:05:17 -05:00
parent fc2d39034b
commit ecac38aa90
9 changed files with 12 additions and 28 deletions

View File

@ -1,6 +0,0 @@
.. toctree::
:maxdepth: 1
oslo_context.context.rst
oslo_context.fixture.rst
oslo_context.tests.test_context.rst

9
doc/source/api/index.rst Normal file
View File

@ -0,0 +1,9 @@
==================
oslo.context API
==================
.. toctree::
:maxdepth: 1
context.rst
fixture.rst

View File

@ -1,7 +0,0 @@
The :mod:`oslo_context.tests.test_context` Module
=================================================
.. automodule:: oslo_context.tests.test_context
:members:
:undoc-members:
:show-inheritance:

View File

@ -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
==================

View File

@ -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

View File

@ -1 +0,0 @@
.. include:: ../../README.rst

View File

@ -4,4 +4,4 @@
To use oslo.context in a project::
from oslo import context
from oslo_context import context