[mirror_ovs.git] / Documentation / contents.rst

..
      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
Commit	Line	Data
daf5079e SF	1	..
	2	Licensed under the Apache License, Version 2.0 (the "License"); you may
	3	not use this file except in compliance with the License. You may obtain
	4	a copy of the License at
	5
	6	http://www.apache.org/licenses/LICENSE-2.0
	7
	8	Unless required by applicable law or agreed to in writing, software
	9	distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
	10	WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
	11	License for the specific language governing permissions and limitations
	12	under the License.
	13
	14	Convention for heading levels in Open vSwitch documentation:
	15
	16	======= Heading 0 (reserved for the title in a document)
	17	------- Heading 1
	18	~~~~~~~ Heading 2
	19	+++++++ Heading 3
	20	''''''' Heading 4
	21
	22	Avoid deeper levels because they do not render well.
	23
	24	===================================
	25	Open vSwitch Documentation Contents
	26	===================================
	27
	28	.. toctree::
	29	:maxdepth: 3
	30
	31	index
11820a1f SF	32
	33	.. toctree::
	34	:maxdepth: 3
	35
	36	intro/index
	37	tutorials/index
11820a1f	38	howto/index
7f79ae2f	39	topics/index
11820a1f	40	ref/index
11820a1f	41	internals/index
7f79ae2f FL	42	intro/install/documentation
7f79ae2f FL	43	faq/index