From 9de339ee505995aee78fc9ec3e4d09c5ad20de53 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Thu, 6 Jul 2017 15:35:44 -0400 Subject: [PATCH] rearrange existing documentation according to the new standard layout Change-Id: I1acfaaecd446953587ec36bda1cd795afed26b43 Signed-off-by: Doug Hellmann --- .../index.rst} | 2 +- doc/source/history.rst | 2 -- doc/source/index.rst | 22 ++++++------------- .../{installation.rst => install/index.rst} | 0 doc/source/{api.rst => reference/index.rst} | 0 doc/source/{ => user}/examples.rst | 0 doc/source/{ => user}/features.rst | 0 doc/source/user/history.rst | 2 ++ doc/source/user/index.rst | 10 +++++++++ 9 files changed, 20 insertions(+), 18 deletions(-) rename doc/source/{contributing.rst => contributor/index.rst} (50%) delete mode 100644 doc/source/history.rst rename doc/source/{installation.rst => install/index.rst} (100%) rename doc/source/{api.rst => reference/index.rst} (100%) rename doc/source/{ => user}/examples.rst (100%) rename doc/source/{ => user}/features.rst (100%) create mode 100644 doc/source/user/history.rst create mode 100644 doc/source/user/index.rst diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst similarity index 50% rename from doc/source/contributing.rst rename to doc/source/contributor/index.rst index 1f5ca23..3d4ceb4 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/index.rst @@ -2,4 +2,4 @@ Contributing ============ -.. include:: ../../CONTRIBUTING.rst +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/history.rst b/doc/source/history.rst deleted file mode 100644 index db8340b..0000000 --- a/doc/source/history.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. include:: ../../ChangeLog - diff --git a/doc/source/index.rst b/doc/source/index.rst index fdbda82..4d9ffda 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,24 +1,16 @@ -Welcome to automaton's documentation! -======================================================== +======================================= + Welcome to automaton's documentation! +======================================= Friendly state machines for python. .. toctree:: :maxdepth: 2 - features - api - installation - examples - contributing - -History -======= - -.. toctree:: - :maxdepth: 2 - - history + user/index + reference/index + install/index + contributor/index Indices and tables ================== diff --git a/doc/source/installation.rst b/doc/source/install/index.rst similarity index 100% rename from doc/source/installation.rst rename to doc/source/install/index.rst diff --git a/doc/source/api.rst b/doc/source/reference/index.rst similarity index 100% rename from doc/source/api.rst rename to doc/source/reference/index.rst diff --git a/doc/source/examples.rst b/doc/source/user/examples.rst similarity index 100% rename from doc/source/examples.rst rename to doc/source/user/examples.rst diff --git a/doc/source/features.rst b/doc/source/user/features.rst similarity index 100% rename from doc/source/features.rst rename to doc/source/user/features.rst diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst new file mode 100644 index 0000000..2632296 --- /dev/null +++ b/doc/source/user/history.rst @@ -0,0 +1,2 @@ +.. include:: ../../../ChangeLog + diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 0000000..f109e35 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,10 @@ +====================== + automaton User Guide +====================== + +.. toctree:: + :maxdepth: 2 + + features + examples + history