Skip to content
Snippets Groups Projects
Commit ac8cdaff authored by Paul McCarthy's avatar Paul McCarthy :mountain_bicyclist:
Browse files

DOC: Note about installing dev dependencies

parent 45998417
No related branches found
No related tags found
No related merge requests found
......@@ -64,12 +64,17 @@ the rest of the extra dependencies::
pip install fslpy[extras]
Dependencies for testing and documentation are listed in the
`requirements-dev.txt <requirements-dev.txt>`_ file.
Documentation
-------------
``fslpy`` is documented using `sphinx <http://http://sphinx-doc.org/>`_. You
can build the API documentation by running::
pip install -r requirements-dev.txt
python setup.py doc
The HTML documentation will be generated and saved in the ``doc/html/``
......@@ -85,6 +90,7 @@ Tests
Run the test suite via::
pip install -r requirements-dev.txt
python setup.py test
A test report will be generated at ``report.html``, and a code coverage report
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment