summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAkihiro Motoki <amotoki@gmail.com>2017-07-08 22:21:46 +0000
committerAkihiro Motoki <amotoki@gmail.com>2017-07-09 01:33:00 +0000
commite1bcf9dff1a9db681838897353e5afe6448ea8fc (patch)
treeee366cfdb89f9c4767a28a92c10cab28c8e8899c
parent3b7dbd6ff830f4751f7282601625de1bde51d214 (diff)
rearrange existing documentation to fit the new standard layout
Notes
Notes (review): Code-Review+1: Dai Dang Van <daidv@vn.fujitsu.com> Code-Review+2: ChangBo Guo(gcb) <glongwave@gmail.com> Code-Review+2: Davanum Srinivas (dims) <davanum@gmail.com> Workflow+1: Davanum Srinivas (dims) <davanum@gmail.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Mon, 10 Jul 2017 19:21:33 +0000 Reviewed-on: https://review.openstack.org/481860 Project: openstack/futurist Branch: refs/heads/master
-rw-r--r--doc/source/contributor/index.rst (renamed from doc/source/contributing.rst)2
-rw-r--r--doc/source/history.rst2
-rw-r--r--doc/source/index.rst17
-rw-r--r--doc/source/install/index.rst (renamed from doc/source/installation.rst)0
-rw-r--r--doc/source/reference/index.rst (renamed from doc/source/api.rst)6
-rw-r--r--doc/source/user/examples.rst (renamed from doc/source/examples.rst)0
-rw-r--r--doc/source/user/features.rst (renamed from doc/source/features.rst)0
-rw-r--r--doc/source/user/history.rst2
-rw-r--r--doc/source/user/index.rst15
-rw-r--r--tox.ini2
10 files changed, 26 insertions, 20 deletions
diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst
index 1f5ca23..3d4ceb4 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributor/index.rst
@@ -2,4 +2,4 @@
2Contributing 2Contributing
3============ 3============
4 4
5.. include:: ../../CONTRIBUTING.rst 5.. 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 @@
1.. include:: ../../ChangeLog
2
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**.
6.. toctree:: 6.. toctree::
7 :maxdepth: 2 7 :maxdepth: 2
8 8
9 features 9 user/index
10 api 10 reference/index
11 installation 11 install/index
12 examples 12 contributor/index
13 contributing
14
15History
16=======
17
18.. toctree::
19 :maxdepth: 2
20
21 history
22 13
23Indices and tables 14Indices and tables
24================== 15==================
diff --git a/doc/source/installation.rst b/doc/source/install/index.rst
index fa02187..fa02187 100644
--- a/doc/source/installation.rst
+++ b/doc/source/install/index.rst
diff --git a/doc/source/api.rst b/doc/source/reference/index.rst
index 44535c9..24b3b14 100644
--- a/doc/source/api.rst
+++ b/doc/source/reference/index.rst
@@ -1,6 +1,6 @@
1=== 1=============
2API 2API Reference
3=== 3=============
4 4
5--------- 5---------
6Executors 6Executors
diff --git a/doc/source/examples.rst b/doc/source/user/examples.rst
index a5b6358..a5b6358 100644
--- a/doc/source/examples.rst
+++ b/doc/source/user/examples.rst
diff --git a/doc/source/features.rst b/doc/source/user/features.rst
index 1ff1dcc..1ff1dcc 100644
--- a/doc/source/features.rst
+++ b/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 @@
1.. include:: ../../../ChangeLog
2
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 @@
1==============
2Using 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
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}'
27commands = 27commands =
28 python setup.py testr --slowest --testr-args='{posargs}' 28 python setup.py testr --slowest --testr-args='{posargs}'
29 sphinx-build -b doctest doc/source doc/build 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[testenv:docs] 32[testenv:docs]
33commands = python setup.py build_sphinx 33commands = python setup.py build_sphinx