Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
gizmoguy committed Dec 2, 2017
1 parent b1b2467 commit b14733f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
6 changes: 4 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,7 @@ Docs are viewable on (readthedocs)[https://faucet.readthedocs.io/]

## Building documentation

$ sudo pip3 install -r requirements.txt
$ make html
```bash
sudo pip3 install -r requirements.txt
make html
```
11 changes: 7 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
Faucet Documentation
====================

User Documentation
==================
------------------

.. toctree::
:maxdepth: 2
Expand All @@ -13,7 +16,7 @@ User Documentation
external_resources

Developer Documentation
=======================
-----------------------

.. toctree::
:maxdepth: 2
Expand All @@ -24,7 +27,7 @@ Developer Documentation
source/index

Quick References
================
----------------

.. toctree::
:maxdepth: 1
Expand All @@ -33,7 +36,7 @@ Quick References


Indices and tables
==================
------------------

* :ref:`genindex`
* :ref:`modindex`
Expand Down

0 comments on commit b14733f

Please sign in to comment.