openstack/oslo.serialization
Code Issues Proposed changes

rearrange existing documentation to fit the new standard layout

Browse Source 
Fixes formatting things related to openstackdocstheme adoption

Change-Id: Ia4272bf073d53ae4075a1b6d860898c0a6121145
This commit is contained in:
Akihiro Motoki 2017-07-06 20:55:08 +00:00
parent ed34d20c38
commit e1f6499c67
7 changed files with 24 additions and 25 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

25
doc/source/index.rst
View File

@ -8,27 +8,12 @@ in transmittable and storable formats, such as JSON and MessagePack.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
installation install/index
contributing user/index
contributor/index
reference/index
API Documentation .. rubric:: Indices and tables
=================
.. toctree::
:maxdepth: 2
api
Release Notes
=============
.. toctree::
:maxdepth: 1
history
Indices and tables
==================
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`

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

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

@ -1,6 +1,6 @@
================= =============
API Documentation API Reference
================= =============
base64 base64

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

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

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

@ -0,0 +1,14 @@
========================
Using oslo.serialization
========================
.. toctree::
:maxdepth: 2
.. Add more contents here
.. history contains a lot of sections, toctree with maxdepth 1 is used.
.. toctree::
:maxdepth: 1
Release Notes <history>