summaryrefslogtreecommitdiff
path: root/Documentation/contents.rst
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2016-12-08 12:55:20 +0000
committerBen Pfaff <blp@ovn.org>2016-12-12 08:46:47 -0800
commitdaf5079e73550f868f0f7ea7c296d395eaff77ad (patch)
tree1b543eb57c0da86c7cd88c9c7ceb8d31ffa507ac /Documentation/contents.rst
parent7971b36c3acc279f8e931d360f16c200752a3be2 (diff)
downloadopenvswitch-daf5079e73550f868f0f7ea7c296d395eaff77ad.tar.gz
Add initial sphinx configuration
This is essentially the output of 'sphinx-quickstart' but with the following changes: - Parts of the generated Makefile are merged into the existing Documentation/automake.mk Makefile - A license is added to the index.rst file - The OVS logo is added - A 'contents' page is added, so we don't need to include a TOC on the home page - The theme is switched to 'bizstyle', which makes better use of horizontal real estate than the default 'alabaster' theme Copyright is assigned to "The Open vSwitch Development Community". Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'Documentation/contents.rst')
-rw-r--r--Documentation/contents.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/Documentation/contents.rst b/Documentation/contents.rst
new file mode 100644
index 000000000..3ecb7412f
--- /dev/null
+++ b/Documentation/contents.rst
@@ -0,0 +1,31 @@
+..
+ 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 Open vSwitch documentation:
+
+ ======= 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.
+
+===================================
+Open vSwitch Documentation Contents
+===================================
+
+.. toctree::
+ :maxdepth: 3
+
+ index