Skip to content

Commit

Permalink
Updated the readme on how to edit the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
stas committed Dec 9, 2016
1 parent ca57068 commit 0529c59
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,19 @@ The documentation for Aleph is available at
Feel free to edit the source files in the ``docs`` folder and send pull
requests for improvements.

To build the documentation, please install the dependencies first and run
``make docs``::

(host)$ docker-compose run app bash
(app) $ pip install -r requirements-docs.txt
(app) $ make docs


Now you can browse the documentation locally at
``http://lvh.me:8000/docs/_build/html/``::

(host)$ make docs-web

Support
-------

Expand Down

0 comments on commit 0529c59

Please sign in to comment.