rearrange existing documentation to fit the new standard layout
Change-Id: I56d60de2c3a8aefa2df834634ff5e6c068d868d4
This commit is contained in:
parent
3b7dbd6ff8
commit
e1bcf9dff1
|
@ -2,4 +2,4 @@
|
|||
Contributing
|
||||
============
|
||||
|
||||
.. include:: ../../CONTRIBUTING.rst
|
||||
.. include:: ../../../CONTRIBUTING.rst
|
|
@ -1,2 +0,0 @@
|
|||
.. include:: ../../ChangeLog
|
||||
|
|
@ -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
|
||||
==================
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
===
|
||||
API
|
||||
===
|
||||
=============
|
||||
API Reference
|
||||
=============
|
||||
|
||||
---------
|
||||
Executors
|
|
@ -0,0 +1,2 @@
|
|||
.. include:: ../../../ChangeLog
|
||||
|
|
@ -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
|
2
tox.ini
2
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
|
||||
|
|
Loading…
Reference in New Issue