From ac8cdaffaee76fa5af3aa8aa04bc868e93b518fb Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauldmccarthy@gmail.com>
Date: Thu, 13 Sep 2018 11:07:49 +0100
Subject: [PATCH] DOC: Note about installing dev dependencies
---
README.rst | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/README.rst b/README.rst
index d753da3ba..e6ab7619d 100644
--- a/README.rst
+++ b/README.rst
@@ -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
--
GitLab