openstack/oslo.context
Code Issues Proposed changes

rearrange the documentation to fit into the new standard layout

Browse Source 
Change-Id: If9bd83a0ac47084e025899cee681feef06265406
This commit is contained in:
Akihiro Motoki 2017-07-05 01:54:52 +09:00
parent 3ce185402e
commit cdb50bed6e
14 changed files with 24 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/contributing.rst → doc/source/contributor/index.rst
View File

@ -2,4 +2,4 @@
Contributing Contributing
============== ==============
.. include:: ../../CONTRIBUTING.rst .. include:: ../../../CONTRIBUTING.rst

1
doc/source/history.rst
View File

@ -1 +0,0 @@
.. include:: ../../ChangeLog

10
doc/source/index.rst
View File

@ -5,11 +5,9 @@ Contents:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
installation install/index
usage user/index
examples contributor/index
contributing
history
Code Documentation Code Documentation
================== ==================
@ -17,7 +15,7 @@ Code Documentation
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
api/index reference/index
Indices and tables Indices and tables
================== ==================

0
doc/source/installation.rst → doc/source/install/index.rst
View File

0
doc/source/api/context.rst → doc/source/reference/context.rst
View File

0
doc/source/api/fixture.rst → doc/source/reference/fixture.rst
View File

6
doc/source/api/index.rst → doc/source/reference/index.rst
View File

@ -1,6 +1,6 @@
================== =============
oslo.context API API reference
================== =============
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

0
doc/source/examples.rst → doc/source/user/examples.rst
View File

0
doc/source/examples/usage.py → doc/source/user/examples/usage.py
View File

0
doc/source/examples/usage_simple.py → doc/source/user/examples/usage_simple.py
View File

0
doc/source/examples/usage_user_identity.py → doc/source/user/examples/usage_user_identity.py
View File

1
doc/source/user/history.rst Normal file
View File

@ -0,0 +1 @@
.. include:: ../../../ChangeLog

15
doc/source/user/index.rst Normal file
View File

@ -0,0 +1,15 @@
==================
Using oslo.context
==================
.. toctree::
:maxdepth: 2
usage
examples
.. history contains a lot of sections, toctree with maxdepth 1 is used.
.. toctree::
:maxdepth: 1
history

0
doc/source/usage.rst → doc/source/user/usage.rst
View File