add how to build docs

This commit is contained in:
Wes Barnett 2021-03-14 10:36:00 -04:00
parent 135e5a91d0
commit c382fbdbf8
No known key found for this signature in database
GPG key ID: 1070BCC98C18BD66

View file

@ -42,3 +42,16 @@ For testing, ``pytest`` is required. To run the tests do:
.. code-block:: bash
make test
Documentation
-------------
To build the documentation, ``sphinx`` is required. To build the documentation you can
do:
.. code-block:: bash
sphinx-build docs/source docs/build
The resulting html documentation will then be located at ``docs/build/index.html``.