openstack/reno
Code Issues Proposed changes

rearrange the existing docs to follow the new standard layout

Browse Source 
Change-Id: Ia033a9243a55f4a7dfd70d5e0515d6d3372d6e08
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2017-06-28 14:43:44 -04:00
parent ebfdb94a20
commit f4e2d83b00
10 changed files with 21 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/contributing.rst
View File

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

5
doc/source/contributor/index.rst Normal file
View File

@ -0,0 +1,5 @@
============
Contributing
============
.. include:: ../../../CONTRIBUTING.rst

11
doc/source/index.rst
View File

@ -6,10 +6,7 @@ Contents
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
design user/index
installation install/index
usage contributor/index
sphinxext releasenotes/index
contributing
history
examples

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

0
doc/source/history.rst → doc/source/releasenotes/index.rst
View File

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

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

@ -5,7 +5,7 @@
Input file Input file
========== ==========
.. literalinclude:: ../../examples/notes/add-complex-example-6b5927c246456896.yaml .. literalinclude:: ../../../examples/notes/add-complex-example-6b5927c246456896.yaml
:caption: examples/notes/add-complex-example-6b5927c246456896.yaml :caption: examples/notes/add-complex-example-6b5927c246456896.yaml
:language: yaml :language: yaml

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

@ -0,0 +1,10 @@
=================
reno User Guide
=================
.. toctree::
design
usage
sphinxext
examples

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

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

@ -141,7 +141,7 @@ not needed for the bullet items in the other sections of the template.
To escape the text of any section and *retain* the newlines, prefix To escape the text of any section and *retain* the newlines, prefix
the value with ``|``. For example: the value with ``|``. For example:
.. include:: ../../examples/notes/add-complex-example-6b5927c246456896.yaml .. include:: ../../../examples/notes/add-complex-example-6b5927c246456896.yaml
:literal: :literal:
See :doc:`examples` for the rendered version of the note. See :doc:`examples` for the rendered version of the note.