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 48c14c3..fd2c269 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,19 +6,10 @@ Code from the future, delivered to you in the **now**. .. 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 96% rename from doc/source/api.rst rename to doc/source/reference/index.rst index 44535c9..24b3b14 100644 --- a/doc/source/api.rst +++ b/doc/source/reference/index.rst @@ -1,6 +1,6 @@ -=== -API -=== +============= +API Reference +============= --------- Executors 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..da8c2e4 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,15 @@ +============== +Using futurist +============== + +.. toctree:: + :maxdepth: 2 + + features + examples + +.. history contains a lot of sections, toctree with maxdepth 1 is used. +.. toctree:: + :maxdepth: 1 + + history diff --git a/tox.ini b/tox.ini index a31062b..59259d4 100644 --- a/tox.ini +++ b/tox.ini @@ -27,7 +27,7 @@ commands = python setup.py test --coverage --testr-args='{posargs}' commands = python setup.py testr --slowest --testr-args='{posargs}' sphinx-build -b doctest doc/source doc/build - doc8 --ignore-path "doc/source/history.rst" doc/source + doc8 --ignore-path "doc/source/user/history.rst" doc/source [testenv:docs] commands = python setup.py build_sphinx