Merge pull request #526 from macartur/fix_tests

Fix sphinx title markers on documentation
kytos · Jul 12, 2017 · 04bba53 · 04bba53
2 parents 7cd99f3 + 2f0079f
commit 04bba53
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 17 deletions.
diff --git a/docs/administrator/architecture.rst b/docs/administrator/architecture.rst
@@ -1,12 +1,12 @@
 Architecture Overview
----------------------
+*********************
 
 *Kytos* is a modular SDN controller, composed by the *Kytos Core*
 and by applications called *Networks Applications* (or *napp*), which means
 it has several parts that working together will compose a Kytos Controller.
 
 Kytos Core
-++++++++++
+==========
 
 The *Kytos Core* is responsible for the main core operations of the
 controller like keeping track of the connected switches, enabling,
@@ -19,11 +19,13 @@ A web interface is being developed to manage the controller. This web
 interface aims to be intuitive and very easy to use.
 
 Network Applications
-++++++++++++++++++++
+====================
+
 The *napps* can be divided into two categories, *kytos napps* and *user napps*.
 
 kytos napps
-~~~~~~~~~~~
+-----------
+
 The *kytos napps* are those needed for the controller to deal with main
 operations with a switch using a certain protocol. ex:
 - *of_core napp* is responsible for providing interaction
@@ -42,7 +44,7 @@ Several core applications were developed. Kytos's developer team is
 constantly developing new core application to improve Kytos's features.
 
 user napps
-~~~~~~~~~~
+----------
 The applications stack are general applications, created by Kytos’s users.
 These applications can be installed, loaded and unloaded on the fly by the
 user. Also, these applications make use of the OpenFlow library and information

diff --git a/docs/administrator/configuration.rst b/docs/administrator/configuration.rst
@@ -1,5 +1,5 @@
 Configuration
--------------
+*************
 
 *Kyco* has several configuration parameters that allows the user to setup the
 controller according to his needs. To configure the *Kyco* you can edit the
@@ -31,7 +31,7 @@ The following parameters are available at ``/etc/kyco/kyco.conf``:
 +-------------+---------------+--------------------------+
 
 Parameters Description
-^^^^^^^^^^^^^^^^^^^^^^
+======================
 
 This section describes all available parameters that can be used during the
 *Kyco* startup. Please note that some parameters are available only at command

diff --git a/docs/administrator/index.rst b/docs/administrator/index.rst
@@ -3,7 +3,7 @@ Administrator Guide
 ###################
 
 Welcome to the **Administrator Guide**, here you will find all information and
-references about *Kythos*.
+references about *Kytos*.
 
 .. include:: intro.rst
 

diff --git a/docs/administrator/logging_and_troubleshooting.rst b/docs/administrator/logging_and_troubleshooting.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Logging and troubleshooting
 ---------------------------
 

diff --git a/docs/administrator/napps_management.rst b/docs/administrator/napps_management.rst
@@ -1,5 +1,5 @@
 NApps management
-----------------
+****************
 
 As mentioned earlier, *Kyco* is composed of several modules. One of these
 modules is the Network Application (Napp), which can be a core Napp,
@@ -10,7 +10,7 @@ installing, removing and enable or disable).
 .. note:: The procedure described here is temporary. It will be updated accordingly.
 
 Installing NApps
-^^^^^^^^^^^^^^^^
+================
 
 To load an application *Kyco* will lookup inside the directory indicated in
 ``napps`` parameter inside the configuration file. By default, this parameter
@@ -31,7 +31,7 @@ all Napp application directory should have the prefix ``of_`` before the Napp's
 name.
 
 Removing NApps
-^^^^^^^^^^^^^^
+==============
 
 To remove a Napp from *Kytos* all the administrator has to do is to delete the
 Napp from ``/var/lib/kytos/napps/kyco/``. Before removing the directory it is
@@ -46,7 +46,7 @@ After removing the directory the administrator can start the *Kyco* again and
 the Napp will not be loaded.
 
 Enable/Disable NApps
-^^^^^^^^^^^^^^^^^^^^
+====================
 
 *Kyco* allows the administrator to prevent that a Napp to be loaded during the
 startup process. As mentioned earlier, *Kyco* will look for Napps inside the

diff --git a/docs/administrator/notifications.rst b/docs/administrator/notifications.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Enabling notifications
 ----------------------
 

diff --git a/docs/administrator/quickstart.rst b/docs/administrator/quickstart.rst
@@ -1,8 +1,8 @@
 Quickstart
-----------
+**********
 
 Docker
-++++++
+======
 
 You do not need to install Kytos to try it.
 
@@ -22,7 +22,7 @@ and you will have your instance of a basic openflow controller built with
 Kytos SDN Platform.
 
 Install
-+++++++
+=======
 
 In order to install and run kytos you need:
 
@@ -37,7 +37,7 @@ In order to install and run kytos you need:
    $ python3.6 -m pip install kytos
 
 Run
-+++
+===
 
 once kytos is installed, you can:
 
@@ -66,7 +66,7 @@ NB:
 	- kytos/of_topology
 	- kytos/of_flow_manager
 	- kytos/of_ipv6drop
-	- kytos/web_topology_layout 
+	- kytos/web_topology_layout
 
 	to do it, run:
 

diff --git a/docs/administrator/requirements.rst b/docs/administrator/requirements.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Requirements
 ------------