summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorvikram.choudhary <vikram.choudhary@huawei.com>2015-12-11 12:30:40 +0530
committervikram.choudhary <vikram.choudhary@huawei.com>2015-12-11 13:57:07 +0530
commit4c96d4a1d5d2eaebcd4fb20d1fd8671f60971543 (patch)
tree59776b1cdcaf0d84d4989bd598089b4e4b708a65 /doc
parenta5384e2486f778e186c5dbbb1271bbd359ea2a2f (diff)
downloadpython-neutronclient-4c96d4a1d5d2eaebcd4fb20d1fd8671f60971543.tar.gz
Adding missing headers to the devref documents
Change-Id: Ie7f8b8d5751ff378e999287c29c1f3e4714ea64a
Diffstat (limited to 'doc')
-rw-r--r--doc/source/devref/cli_option_guideline.rst23
-rw-r--r--doc/source/devref/client_command_extensions.rst23
-rw-r--r--doc/source/index.rst24
-rw-r--r--doc/source/usage/cli.rst23
-rw-r--r--doc/source/usage/library.rst23
5 files changed, 110 insertions, 6 deletions
diff --git a/doc/source/devref/cli_option_guideline.rst b/doc/source/devref/cli_option_guideline.rst
index 0d51ef6..bd2625d 100644
--- a/doc/source/devref/cli_option_guideline.rst
+++ b/doc/source/devref/cli_option_guideline.rst
@@ -1,4 +1,25 @@
-====================
+..
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+
+ Convention for heading levels in Neutron devref:
+ ======= Heading 0 (reserved for the title in a document)
+ ------- Heading 1
+ ~~~~~~~ Heading 2
+ +++++++ Heading 3
+ ''''''' Heading 4
+ (Avoid deeper levels because they do not render well.)
+
CLI Option Guideline
====================
diff --git a/doc/source/devref/client_command_extensions.rst b/doc/source/devref/client_command_extensions.rst
index 79025be..4b74cdf 100644
--- a/doc/source/devref/client_command_extensions.rst
+++ b/doc/source/devref/client_command_extensions.rst
@@ -1,4 +1,25 @@
-=================================
+..
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+
+ Convention for heading levels in Neutron devref:
+ ======= Heading 0 (reserved for the title in a document)
+ ------- Heading 1
+ ~~~~~~~ Heading 2
+ +++++++ Heading 3
+ ''''''' Heading 4
+ (Avoid deeper levels because they do not render well.)
+
Client command extension support
=================================
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 4ed2049..fb34a0a 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,4 +1,24 @@
-===============================================
+..
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+ Convention for heading levels in Neutron devref:
+ ======= Heading 0 (reserved for the title in a document)
+ ------- Heading 1
+ ~~~~~~~ Heading 2
+ +++++++ Heading 3
+ ''''''' Heading 4
+ (Avoid deeper levels because they do not render well.)
+
Python bindings to the OpenStack Networking API
===============================================
@@ -7,7 +27,7 @@ This is a client for OpenStack Networking API. There is a :doc:`Python API
<usage/cli>` (installed as **neutron**). Each implements the entire OpenStack
Networking API.
-Using neturonclient
+Using neutronclient
-------------------
.. toctree::
diff --git a/doc/source/usage/cli.rst b/doc/source/usage/cli.rst
index 6977321..e898386 100644
--- a/doc/source/usage/cli.rst
+++ b/doc/source/usage/cli.rst
@@ -1,4 +1,25 @@
-======================
+..
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+
+ Convention for heading levels in Neutron devref:
+ ======= Heading 0 (reserved for the title in a document)
+ ------- Heading 1
+ ~~~~~~~ Heading 2
+ +++++++ Heading 3
+ ''''''' Heading 4
+ (Avoid deeper levels because they do not render well.)
+
Command-line Interface
======================
diff --git a/doc/source/usage/library.rst b/doc/source/usage/library.rst
index 8e9a61c..44ff5a6 100644
--- a/doc/source/usage/library.rst
+++ b/doc/source/usage/library.rst
@@ -1,4 +1,25 @@
-========================
+..
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+
+ Convention for heading levels in Neutron devref:
+ ======= Heading 0 (reserved for the title in a document)
+ ------- Heading 1
+ ~~~~~~~ Heading 2
+ +++++++ Heading 3
+ ''''''' Heading 4
+ (Avoid deeper levels because they do not render well.)
+
neutronclient Python API
========================