last fix for read the docs doc heirarchy.

reputage · Aug 21, 2018 · bc3a989 · bc3a989
1 parent b915401
commit bc3a989
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 13 deletions.
diff --git a/docs/getting_started.md → docs/getting_started/getting_started.md b/docs/getting_started.md → docs/getting_started/getting_started.md
@@ -1,7 +1,5 @@
-# Getting Started
-
-## Installation
-
+Installation
+============
 
 This project depends on [python 3.6](https://www.python.org/downloads/).  You will need to install it if you haven't already.
 
@@ -41,7 +39,8 @@ $ make && make check
 $ sudo make install  
 ```
 
-## Starting The Server
+Starting The Server
+===================
 
 To start up the server simply run the command below
 
@@ -68,7 +67,8 @@ You can manage the backend from your browser by going to:
 http://localhost:8080
 ```
 
-## Testing
+Testing
+=======
 
 You will first need to clone the GitHub repo if you installed using the Pypi wheel. There are two sets of unit tests included in the project. The first of which tests the didery backend and can be run using the command:
 ```

diff --git a/docs/getting_started.rst → docs/getting_started/getting_started.rst b/docs/getting_started.rst → docs/getting_started/getting_started.rst
@@ -1,8 +1,5 @@
-Getting Started
-===============
-
 Installation
-------------
+============
 
 This project depends on `python
 3.6 <https://www.python.org/downloads/>`__. You will need to install it
@@ -60,7 +57,7 @@ Linux
     $ sudo make install  
 
 Starting The Server
--------------------
+===================
 
 To start up the server simply run the command below
 
@@ -93,7 +90,7 @@ You can manage the backend from your browser by going to:
     http://localhost:8080
 
 Testing
--------
+=======
 
 You will first need to clone the GitHub repo if you installed using the
 Pypi wheel. There are two sets of unit tests included in the project.

diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst
@@ -0,0 +1,10 @@
+########
+Getting Started
+########
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+   :titlesonly:
+
+   getting_started
diff --git a/docs/index.rst b/docs/index.rst
@@ -44,7 +44,7 @@ frontend is built with
    :glob:
    :titlesonly:
 
-   getting_started
+   getting_started/index
    api/index
    frontend/index
    decentralized_autonomic_data