mirror of
https://github.com/openvswitch/ovs
synced 2025-08-30 22:05:19 +00:00
7f79ae2fb6
The initial website page is difficult to read because of the large amount of links from different parts of the whole documentation. Most of all those links come from their index page referenced in the section 'Contents' on the side. Another issue is that because the page is static, new links might not get included. This patch simplifies the main page by highlighting the project level documentation. The static part is reduced to the main level index pages. All the links are available by clicking on 'Full Table of Contents' at the end of Documentation section. Signed-off-by: Flavio Leitner <fbl@sysclose.org> Signed-off-by: Ben Pfaff <blp@ovn.org>
44 lines
1.2 KiB
ReStructuredText
44 lines
1.2 KiB
ReStructuredText
..
|
|
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
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
intro/index
|
|
tutorials/index
|
|
howto/index
|
|
topics/index
|
|
ref/index
|
|
internals/index
|
|
intro/install/documentation
|
|
faq/index
|