Browse Source

rearrange existing documentation to fit the new standard layout

Change-Id: I56d60de2c3a8aefa2df834634ff5e6c068d868d4
tags/1.3.0
Akihiro Motoki 1 year ago
parent
commit
e1bcf9dff1

doc/source/contributing.rst → doc/source/contributor/index.rst View File

@@ -2,4 +2,4 @@
2 2
 Contributing
3 3
 ============
4 4
 
5
-.. include:: ../../CONTRIBUTING.rst
5
+.. include:: ../../../CONTRIBUTING.rst

+ 0
- 2
doc/source/history.rst View File

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

+ 4
- 13
doc/source/index.rst View File

@@ -6,19 +6,10 @@ Code from the future, delivered to you in the **now**.
6 6
 .. toctree::
7 7
    :maxdepth: 2
8 8
 
9
-   features
10
-   api
11
-   installation
12
-   examples
13
-   contributing
14
-
15
-History
16
-=======
17
-
18
-.. toctree::
19
-   :maxdepth: 2
20
-
21
-   history
9
+   user/index
10
+   reference/index
11
+   install/index
12
+   contributor/index
22 13
 
23 14
 Indices and tables
24 15
 ==================

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


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

@@ -1,6 +1,6 @@
1
-===
2
-API
3
-===
1
+=============
2
+API Reference
3
+=============
4 4
 
5 5
 ---------
6 6
 Executors

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


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


+ 2
- 0
doc/source/user/history.rst View File

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

+ 15
- 0
doc/source/user/index.rst View File

@@ -0,0 +1,15 @@
1
+==============
2
+Using futurist
3
+==============
4
+
5
+.. toctree::
6
+   :maxdepth: 2
7
+
8
+   features
9
+   examples
10
+
11
+.. history contains a lot of sections, toctree with maxdepth 1 is used.
12
+.. toctree::
13
+   :maxdepth: 1
14
+
15
+   history

+ 1
- 1
tox.ini View File

@@ -27,7 +27,7 @@ commands = python setup.py test --coverage --testr-args='{posargs}'
27 27
 commands =
28 28
     python setup.py testr --slowest --testr-args='{posargs}'
29 29
     sphinx-build -b doctest doc/source doc/build
30
-    doc8 --ignore-path "doc/source/history.rst" doc/source
30
+    doc8 --ignore-path "doc/source/user/history.rst" doc/source
31 31
 
32 32
 [testenv:docs]
33 33
 commands = python setup.py build_sphinx

Loading…
Cancel
Save