Skip to content

Commit

Permalink
README: Document how to build the docs locally
Browse files Browse the repository at this point in the history
  • Loading branch information
tsibley committed May 24, 2019
1 parent f87364c commit faed39b
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,29 @@ build to keep the Docker image up-to-date.

[docker-base]: https://github.com/nextstrain/docker-base

### Building documentation

[Documentation](https://nextstrain-augur.readthedocs.io) is built using
[Sphinx](http://sphinx-doc.org/) and hosted on [Read The
Docs](https://readthedocs.org/). Versions of the documentation for each augur
release and git branch are available and preserved.

Building the documentation locally is useful to test changes. First, make sure
you have the development dependencies of augur installed:

pip install '.[dev]'

This installs packages listed in the `dev` section of `extras_require` in
_setup.py_ (in addition to any normal augur dependencies if necessary).

Then build the HTML output format by running:

make -C docs html

You can see other available formats by running:

make -C docs help

## License and copyright

Copyright 2014-2019 Trevor Bedford and Richard Neher.
Expand Down

0 comments on commit faed39b

Please sign in to comment.