openstack/automaton
Code Issues Proposed changes

rearrange existing documentation according to the new standard layout

Browse Source 
Change-Id: I1acfaaecd446953587ec36bda1cd795afed26b43
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2017-07-06 15:35:44 -04:00
parent 7ad9100169
commit 9de339ee50
9 changed files with 20 additions and 18 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

2
doc/source/history.rst
View File

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

20
doc/source/index.rst
View File

@ -1,24 +1,16 @@
=======================================
Welcome to automaton's documentation! Welcome to automaton's documentation!
======================================================== =======================================
Friendly state machines for python. Friendly state machines for python.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
features user/index
api reference/index
installation install/index
examples contributor/index
contributing
History
=======
.. toctree::
:maxdepth: 2
history
Indices and tables Indices and tables
================== ==================

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

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

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

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

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

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

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

@ -0,0 +1,10 @@
======================
automaton User Guide
======================
.. toctree::
:maxdepth: 2
features
examples
history