From 2d156a4a284efe96bc8de2026449fd6d9f0ac32a Mon Sep 17 00:00:00 2001 From: Jan Gosmann Date: Thu, 7 Jun 2018 14:39:16 -0400 Subject: [PATCH] Document how to build the documentation. --- CONTRIBUTING.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b38095a59..fbaf6d916 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -21,6 +21,33 @@ requests. We try to maintain 100% test coverage, so any new features should also include unit tests to cover that change. If you fix a bug it's also a good idea to add a unit test, so the bug doesn't get un-fixed in the future! + +Building the documentation +-------------------------- + +To build the documentation install the required dependencies by running +the following command from the root folder of the Nengo SPA source code: + +.. code-block:: bash + + python setup.py -e .[docs] + +To build the documentation use one of the following commands: + +.. code-block:: bash + + python setup.py build_sphinx + +or if you need set explicitly set the Jupyter kernel for building the +notebooks included in the documentation: + +.. code-block:: bash + + sphinx-build docs docs/_build -D nbsphinx_kernel_name= + +You will find the build documentation in the ``docs/_build`` folder. + + Contributor agreement ---------------------