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:
parent
fc2d39034b
commit
ecac38aa90
@ -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
9
doc/source/api/index.rst
Normal file
@ -0,0 +1,9 @@
|
||||
==================
|
||||
oslo.context API
|
||||
==================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
context.rst
|
||||
fixture.rst
|
@ -1,7 +0,0 @@
|
||||
The :mod:`oslo_context.tests.test_context` Module
|
||||
=================================================
|
||||
|
||||
.. automodule:: oslo_context.tests.test_context
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
@ -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
|
||||
==================
|
||||
|
@ -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
|
@ -1 +0,0 @@
|
||||
.. include:: ../../README.rst
|
@ -4,4 +4,4 @@
|
||||
|
||||
To use oslo.context in a project::
|
||||
|
||||
from oslo import context
|
||||
from oslo_context import context
|
||||
|
Loading…
Reference in New Issue
Block a user