From c382fbdbf8a7cd1a23df295e504d2b25ba574a9d Mon Sep 17 00:00:00 2001 From: Wes Barnett Date: Sun, 14 Mar 2021 10:36:00 -0400 Subject: [PATCH] add how to build docs --- docs/source/installation.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index c60aeca..6f6aa1e 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -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``.