summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-06-17 10:10:45 +0000
committerGerrit Code Review <review@openstack.org>2017-06-17 10:10:45 +0000
commitbaa4ac9151722d053051f083da48fc815f71e491 (patch)
tree5d9a23624e4b107d9808e3ff5701de01344ccede
parentf89a2467d837dc3c94cba0dcfdf5c142aa0c94b9 (diff)
parenta23cd43abe799af1b72b14c786f2fc9dbd8d3ec4 (diff)
Merge "docs: reorganize developer reference for new theme"
-rw-r--r--TESTING.rst1
-rw-r--r--doc/source/devref/development.environment.rst4
-rw-r--r--doc/source/devref/index.rst71
-rw-r--r--doc/source/devref/modules.rst36
-rw-r--r--doc/source/devref/neutron_internals.rst63
-rw-r--r--doc/source/devref/testing.rst26
-rw-r--r--doc/source/devref/testing_index.rst37
-rw-r--r--doc/source/feature_classification/index.rst10
-rw-r--r--doc/source/index.rst6
9 files changed, 173 insertions, 81 deletions
diff --git a/TESTING.rst b/TESTING.rst
index 34d62b1..70a1d67 100644
--- a/TESTING.rst
+++ b/TESTING.rst
@@ -20,6 +20,7 @@
20 ''''''' Heading 4 20 ''''''' Heading 4
21 (Avoid deeper levels because they do not render well.) 21 (Avoid deeper levels because they do not render well.)
22 22
23.. _testing_neutron:
23 24
24Testing Neutron 25Testing Neutron
25=============== 26===============
diff --git a/doc/source/devref/development.environment.rst b/doc/source/devref/development.environment.rst
index 4a74e12..9a73e53 100644
--- a/doc/source/devref/development.environment.rst
+++ b/doc/source/devref/development.environment.rst
@@ -55,5 +55,7 @@ Grab the code::
55 git clone git://git.openstack.org/openstack/neutron.git 55 git clone git://git.openstack.org/openstack/neutron.git
56 cd neutron 56 cd neutron
57 57
58Testing Neutron
59---------------
58 60
59.. include:: ../../../TESTING.rst 61See :ref:`testing_neutron`.
diff --git a/doc/source/devref/index.rst b/doc/source/devref/index.rst
index 9a375d3..a860785 100644
--- a/doc/source/devref/index.rst
+++ b/doc/source/devref/index.rst
@@ -33,11 +33,8 @@ including its database, message queue, and scheduler components. There are
33also subsections that describe specific plugins inside Neutron. Finally, 33also subsections that describe specific plugins inside Neutron. Finally,
34the developer guide includes information about Neutron testing infrastructure. 34the developer guide includes information about Neutron testing infrastructure.
35 35
36
37Programming HowTos and Tutorials
38--------------------------------
39.. toctree:: 36.. toctree::
40 :maxdepth: 3 37 :maxdepth: 2
41 38
42 effective_neutron 39 effective_neutron
43 development.environment 40 development.environment
@@ -45,68 +42,4 @@ Programming HowTos and Tutorials
45 neutron_api 42 neutron_api
46 client_command_extensions 43 client_command_extensions
47 alembic_migrations 44 alembic_migrations
48 45 modules
49
50Neutron Internals
51-----------------
52.. toctree::
53 :maxdepth: 3
54
55 services_and_agents
56 api_layer
57 ml2_ext_manager
58 calling_ml2_plugin
59 quota
60 api_extensions
61 plugin-api
62 db_layer
63 db_models
64 policy
65 rpc_api
66 rpc_callbacks
67 layer3
68 l2_agents
69 agent_extensions
70 ovs_vhostuser
71 quality_of_service
72 service_extensions
73 dns_order
74 external_dns_integration
75 upgrade
76 objects_usage
77 i18n
78 address_scopes
79 openvswitch_firewall
80 network_ip_availability
81 tag
82 provisioning_blocks
83 retries
84 l3_agent_extensions
85 live_migration
86
87Testing
88-------
89.. toctree::
90 :maxdepth: 3
91
92 fullstack_testing
93 testing_coverage
94 template_model_sync_test
95 db_transient_failure_injection
96
97Module Reference
98----------------
99.. toctree::
100 :maxdepth: 3
101
102.. todo::
103
104 Add in all the big modules as automodule indexes.
105
106
107Indices and tables
108------------------
109
110* :ref:`genindex`
111* :ref:`modindex`
112* :ref:`search`
diff --git a/doc/source/devref/modules.rst b/doc/source/devref/modules.rst
new file mode 100644
index 0000000..1afca02
--- /dev/null
+++ b/doc/source/devref/modules.rst
@@ -0,0 +1,36 @@
1..
2 Copyright 2010-2011 United States Government as represented by the
3 Administrator of the National Aeronautics and Space Administration.
4 All Rights Reserved.
5
6 Licensed under the Apache License, Version 2.0 (the "License"); you may
7 not use this file except in compliance with the License. You may obtain
8 a copy of the License at
9
10 http://www.apache.org/licenses/LICENSE-2.0
11
12 Unless required by applicable law or agreed to in writing, software
13 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15 License for the specific language governing permissions and limitations
16 under the License.
17
18 Convention for heading levels in Neutron devref:
19 ======= Heading 0 (reserved for the title in a document)
20 ------- Heading 1
21 ~~~~~~~ Heading 2
22 +++++++ Heading 3
23 ''''''' Heading 4
24 (Avoid deeper levels because they do not render well.)
25
26
27Module Reference
28================
29
30.. toctree::
31 :maxdepth: 3
32
33.. todo::
34
35 Add in all the big modules as automodule indexes.
36
diff --git a/doc/source/devref/neutron_internals.rst b/doc/source/devref/neutron_internals.rst
new file mode 100644
index 0000000..edc2f84
--- /dev/null
+++ b/doc/source/devref/neutron_internals.rst
@@ -0,0 +1,63 @@
1..
2 Copyright 2010-2011 United States Government as represented by the
3 Administrator of the National Aeronautics and Space Administration.
4 All Rights Reserved.
5
6 Licensed under the Apache License, Version 2.0 (the "License"); you may
7 not use this file except in compliance with the License. You may obtain
8 a copy of the License at
9
10 http://www.apache.org/licenses/LICENSE-2.0
11
12 Unless required by applicable law or agreed to in writing, software
13 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15 License for the specific language governing permissions and limitations
16 under the License.
17
18 Convention for heading levels in Neutron devref:
19 ======= Heading 0 (reserved for the title in a document)
20 ------- Heading 1
21 ~~~~~~~ Heading 2
22 +++++++ Heading 3
23 ''''''' Heading 4
24 (Avoid deeper levels because they do not render well.)
25
26=================
27Neutron Internals
28=================
29
30.. toctree::
31 :maxdepth: 1
32
33 services_and_agents
34 api_layer
35 ml2_ext_manager
36 calling_ml2_plugin
37 quota
38 api_extensions
39 plugin-api
40 db_layer
41 db_models
42 policy
43 rpc_api
44 rpc_callbacks
45 layer3
46 l2_agents
47 agent_extensions
48 ovs_vhostuser
49 quality_of_service
50 service_extensions
51 dns_order
52 external_dns_integration
53 upgrade
54 objects_usage
55 i18n
56 address_scopes
57 openvswitch_firewall
58 network_ip_availability
59 tag
60 provisioning_blocks
61 retries
62 l3_agent_extensions
63 live_migration
diff --git a/doc/source/devref/testing.rst b/doc/source/devref/testing.rst
new file mode 100644
index 0000000..3403744
--- /dev/null
+++ b/doc/source/devref/testing.rst
@@ -0,0 +1,26 @@
1..
2 Copyright 2010-2011 United States Government as represented by the
3 Administrator of the National Aeronautics and Space Administration.
4 All Rights Reserved.
5
6 Licensed under the Apache License, Version 2.0 (the "License"); you may
7 not use this file except in compliance with the License. You may obtain
8 a copy of the License at
9
10 http://www.apache.org/licenses/LICENSE-2.0
11
12 Unless required by applicable law or agreed to in writing, software
13 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15 License for the specific language governing permissions and limitations
16 under the License.
17
18 Convention for heading levels in Neutron devref:
19 ======= Heading 0 (reserved for the title in a document)
20 ------- Heading 1
21 ~~~~~~~ Heading 2
22 +++++++ Heading 3
23 ''''''' Heading 4
24 (Avoid deeper levels because they do not render well.)
25
26.. include:: ../../../TESTING.rst
diff --git a/doc/source/devref/testing_index.rst b/doc/source/devref/testing_index.rst
new file mode 100644
index 0000000..64a52ab
--- /dev/null
+++ b/doc/source/devref/testing_index.rst
@@ -0,0 +1,37 @@
1..
2 Copyright 2010-2011 United States Government as represented by the
3 Administrator of the National Aeronautics and Space Administration.
4 All Rights Reserved.
5
6 Licensed under the Apache License, Version 2.0 (the "License"); you may
7 not use this file except in compliance with the License. You may obtain
8 a copy of the License at
9
10 http://www.apache.org/licenses/LICENSE-2.0
11
12 Unless required by applicable law or agreed to in writing, software
13 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15 License for the specific language governing permissions and limitations
16 under the License.
17
18 Convention for heading levels in Neutron devref:
19 ======= Heading 0 (reserved for the title in a document)
20 ------- Heading 1
21 ~~~~~~~ Heading 2
22 +++++++ Heading 3
23 ''''''' Heading 4
24 (Avoid deeper levels because they do not render well.)
25
26=======
27Testing
28=======
29
30.. toctree::
31 :maxdepth: 2
32
33 testing
34 fullstack_testing
35 testing_coverage
36 template_model_sync_test
37 db_transient_failure_injection
diff --git a/doc/source/feature_classification/index.rst b/doc/source/feature_classification/index.rst
index b3fb5e7..df0778c 100644
--- a/doc/source/feature_classification/index.rst
+++ b/doc/source/feature_classification/index.rst
@@ -28,16 +28,8 @@ Neutron Feature Classification
28============================== 28==============================
29 29
30.. toctree:: 30.. toctree::
31 :maxdepth: 3 31 :maxdepth: 2
32 32
33 feature_classification_introduction 33 feature_classification_introduction
34 general_feature_support_matrix 34 general_feature_support_matrix
35 provider_network_support_matrix 35 provider_network_support_matrix
36
37
38Indices and tables
39------------------
40
41* :ref:`genindex`
42* :ref:`modindex`
43* :ref:`search`
diff --git a/doc/source/index.rst b/doc/source/index.rst
index f5805c6..1822343 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -59,7 +59,7 @@ Neutron Feature Classification
59------------------------------ 59------------------------------
60 60
61.. toctree:: 61.. toctree::
62 :maxdepth: 3 62 :maxdepth: 2
63 63
64 feature_classification/index 64 feature_classification/index
65 65
@@ -67,9 +67,11 @@ Developer Docs
67-------------- 67--------------
68 68
69.. toctree:: 69.. toctree::
70 :maxdepth: 3 70 :maxdepth: 2
71 71
72 devref/index 72 devref/index
73 devref/testing_index
74 devref/neutron_internals
73 75
74Dashboards 76Dashboards
75---------- 77----------