add how to build docs
This commit is contained in:
parent
135e5a91d0
commit
c382fbdbf8
1 changed files with 13 additions and 0 deletions
|
|
@ -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``.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue