Browse Source

rearrange existing documentation to fit the new standard layout

Change-Id: Iac95a337ac0a3ae8da1dd7c0a575c4d7b68fe632
Akihiro Motoki 1 year ago
parent
commit
9d3fbc726f

+ 3
- 6
CONTRIBUTING.rst View File

@@ -1,16 +1,13 @@
1 1
 If you would like to contribute to the development of OpenStack,
2 2
 you must follow the steps in this page:
3
-
4
-   http://docs.openstack.org/infra/manual/developers.html
3
+http://docs.openstack.org/infra/manual/developers.html
5 4
 
6 5
 Once those steps have been completed, changes to OpenStack
7 6
 should be submitted for review via the Gerrit tool, following
8 7
 the workflow documented at:
9
-
10
-   http://docs.openstack.org/infra/manual/developers.html#development-workflow
8
+http://docs.openstack.org/infra/manual/developers.html#development-workflow
11 9
 
12 10
 Pull requests submitted through GitHub will be ignored.
13 11
 
14 12
 Bugs should be filed on Launchpad, not GitHub:
15
-
16
-   https://bugs.launchpad.net/debtcollector
13
+https://bugs.launchpad.net/debtcollector

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
- 1
doc/source/history.rst View File

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

+ 6
- 17
doc/source/index.rst View File

@@ -1,3 +1,4 @@
1
+=========================================
1 2
 Welcome to debtcollector's documentation!
2 3
 =========================================
3 4
 
@@ -11,27 +12,15 @@ collect your technical debt in a non-destructive manner.
11 12
     integration is it aims to be generally usable and useful in any
12 13
     project.
13 14
 
14
-Contents
15
-========
16
-
17 15
 .. toctree::
18 16
    :maxdepth: 2
19 17
 
20
-   installation
21
-   api
22
-   examples
23
-   contributing
24
-
25
-Release Notes
26
-=============
27
-
28
-.. toctree::
29
-   :maxdepth: 1
30
-
31
-   history
18
+   install/index
19
+   user/index
20
+   reference/index
21
+   contributor/index
32 22
 
33
-Indices and tables
34
-==================
23
+.. rubric:: Indices and tables
35 24
 
36 25
 * :ref:`genindex`
37 26
 * :ref:`modindex`

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
 The currently documented publicly exposed API's for usage in your project

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

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

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

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

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


+ 4
- 4
releasenotes/source/index.rst View File

@@ -2,8 +2,8 @@
2 2
  debtcollector Release Notes
3 3
 =============================
4 4
 
5
- .. toctree::
6
-    :maxdepth: 1
5
+.. toctree::
6
+   :maxdepth: 1
7 7
 
8
-    unreleased
9
-    ocata
8
+   unreleased
9
+   ocata

Loading…
Cancel
Save