Quellcode durchsuchen

rearrange existing documentation to fit the new standard layout

Change-Id: I56d60de2c3a8aefa2df834634ff5e6c068d868d4
tags/1.3.0
Akihiro Motoki vor 2 Jahren
Ursprung
Commit
e1bcf9dff1

doc/source/contributing.rst → doc/source/contributor/index.rst Datei anzeigen

@@ -2,4 +2,4 @@
Contributing
============

.. include:: ../../CONTRIBUTING.rst
.. include:: ../../../CONTRIBUTING.rst

+ 0
- 2
doc/source/history.rst Datei anzeigen

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


+ 4
- 13
doc/source/index.rst Datei anzeigen

@@ -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
==================

doc/source/installation.rst → doc/source/install/index.rst Datei anzeigen


doc/source/api.rst → doc/source/reference/index.rst Datei anzeigen

@@ -1,6 +1,6 @@
===
API
===
=============
API Reference
=============

---------
Executors

doc/source/examples.rst → doc/source/user/examples.rst Datei anzeigen


doc/source/features.rst → doc/source/user/features.rst Datei anzeigen


+ 2
- 0
doc/source/user/history.rst Datei anzeigen

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


+ 15
- 0
doc/source/user/index.rst Datei anzeigen

@@ -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

+ 1
- 1
tox.ini Datei anzeigen

@@ -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

Laden…
Abbrechen
Speichern