Skip to content

Commit

Permalink
updating heirarchy for read the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ntelfer committed Aug 21, 2018
1 parent 2ae062a commit b915401
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
14 changes: 8 additions & 6 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Installation
============
# Getting Started

## Installation


This project depends on [python 3.6](https://www.python.org/downloads/). You will need to install it if you haven't already.

Expand Down Expand Up @@ -39,8 +41,8 @@ $ make && make check
$ sudo make install
```

Starting The Server
==================
## Starting The Server

To start up the server simply run the command below

```
Expand All @@ -66,8 +68,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:
```
$ pytest --ignore=src/didery/static/
Expand Down
9 changes: 6 additions & 3 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
Getting Started
===============

Installation
============
------------

This project depends on `python
3.6 <https://www.python.org/downloads/>`__. You will need to install it
Expand Down Expand Up @@ -57,7 +60,7 @@ Linux
$ sudo make install

Starting The Server
===================
-------------------

To start up the server simply run the command below

Expand Down Expand Up @@ -90,7 +93,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.
Expand Down

0 comments on commit b915401

Please sign in to comment.