summaryrefslogtreecommitdiff
path: root/Documentation/contents.rst
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: Simplify the website main page.Flavio Leitner2021-01-071-2/+3
| | | | | | | | | | | | | | | | | | | | 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>
* doc: Create directory structureStephen Finucane2016-12-121-0/+11
| | | | | | | | | | | | | | | | | | | | | Create a series of sections, all of which are currently empty, using the general design established by Jacob Kaplan-Moss and the Django project [1]. Five sections are provided: - intro - tutorials - topics - howto - ref - faq - internals The purpose of each section is described in the documents themselves. [1] https://jacobian.org/writing/great-documentation/ Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ben Pfaff <blp@ovn.org>
* Add initial sphinx configurationStephen Finucane2016-12-121-0/+31
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>