rearrange existing documentation to fit the new standard layout
Change-Id: I0727caae202b385d740b006fd957b990e308c6d7
This commit is contained in:
parent
d14dfdf5c4
commit
0f3ea232b7
@ -1,5 +0,0 @@
|
|||||||
==============
|
|
||||||
Contributing
|
|
||||||
==============
|
|
||||||
|
|
||||||
.. include:: ../../CONTRIBUTING.rst
|
|
5
doc/source/contributor/index.rst
Normal file
5
doc/source/contributor/index.rst
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
============
|
||||||
|
Contributing
|
||||||
|
============
|
||||||
|
|
||||||
|
.. include:: ../../../CONTRIBUTING.rst
|
@ -1 +0,0 @@
|
|||||||
.. include:: ../../ChangeLog
|
|
@ -8,51 +8,12 @@ such as encoding, exception handling, string manipulation, and time handling.
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
installation
|
install/index
|
||||||
usage
|
user/index
|
||||||
contributing
|
reference/index
|
||||||
|
contributor/index
|
||||||
|
|
||||||
API Documentation
|
.. rubric:: Indices and tables
|
||||||
=================
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
api/dictutils
|
|
||||||
api/encodeutils
|
|
||||||
api/eventletutils
|
|
||||||
api/excutils
|
|
||||||
api/fileutils
|
|
||||||
api/fixture
|
|
||||||
api/importutils
|
|
||||||
api/netutils
|
|
||||||
api/reflection
|
|
||||||
api/secretutils
|
|
||||||
api/specs_matcher
|
|
||||||
api/strutils
|
|
||||||
api/timeutils
|
|
||||||
api/units
|
|
||||||
api/uuidutils
|
|
||||||
api/versionutils
|
|
||||||
|
|
||||||
Examples
|
|
||||||
========
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
examples/timeutils
|
|
||||||
|
|
||||||
Release Notes
|
|
||||||
=============
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
history
|
|
||||||
|
|
||||||
Indices and tables
|
|
||||||
==================
|
|
||||||
|
|
||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
* :ref:`modindex`
|
* :ref:`modindex`
|
||||||
|
23
doc/source/reference/index.rst
Normal file
23
doc/source/reference/index.rst
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
=============
|
||||||
|
API Reference
|
||||||
|
=============
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
dictutils
|
||||||
|
encodeutils
|
||||||
|
eventletutils
|
||||||
|
excutils
|
||||||
|
fileutils
|
||||||
|
fixture
|
||||||
|
importutils
|
||||||
|
netutils
|
||||||
|
reflection
|
||||||
|
secretutils
|
||||||
|
specs_matcher
|
||||||
|
strutils
|
||||||
|
timeutils
|
||||||
|
units
|
||||||
|
uuidutils
|
||||||
|
versionutils
|
1
doc/source/user/history.rst
Normal file
1
doc/source/user/history.rst
Normal file
@ -0,0 +1 @@
|
|||||||
|
.. include:: ../../../ChangeLog
|
15
doc/source/user/index.rst
Normal file
15
doc/source/user/index.rst
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
==================
|
||||||
|
Using oslo.service
|
||||||
|
==================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
usage
|
||||||
|
timeutils
|
||||||
|
|
||||||
|
.. history contains a lot of sections, toctree with maxdepth 1 is used.
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
history
|
Loading…
Reference in New Issue
Block a user