rearrange the existing docs to follow the new standard layout
Change-Id: Ia033a9243a55f4a7dfd70d5e0515d6d3372d6e08 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
parent
ebfdb94a20
commit
f4e2d83b00
@ -1,4 +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
|
@ -6,10 +6,7 @@ Contents
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
design
|
||||
installation
|
||||
usage
|
||||
sphinxext
|
||||
contributing
|
||||
history
|
||||
examples
|
||||
user/index
|
||||
install/index
|
||||
contributor/index
|
||||
releasenotes/index
|
||||
|
@ -5,7 +5,7 @@
|
||||
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
|
||||
:language: yaml
|
||||
|
10
doc/source/user/index.rst
Normal file
10
doc/source/user/index.rst
Normal file
@ -0,0 +1,10 @@
|
||||
=================
|
||||
reno User Guide
|
||||
=================
|
||||
|
||||
.. toctree::
|
||||
|
||||
design
|
||||
usage
|
||||
sphinxext
|
||||
examples
|
@ -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
|
||||
the value with ``|``. For example:
|
||||
|
||||
.. include:: ../../examples/notes/add-complex-example-6b5927c246456896.yaml
|
||||
.. include:: ../../../examples/notes/add-complex-example-6b5927c246456896.yaml
|
||||
:literal:
|
||||
|
||||
See :doc:`examples` for the rendered version of the note.
|
Loading…
Reference in New Issue
Block a user