install documentation

belbio · Jan 5, 2018 · 97ac321 · 97ac321
1 parent 7bccb88
commit 97ac321
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -15,5 +15,13 @@ Developers
 
 If you are a developer, please see the :doc:`link_contributing` first and then:
 
+    git clone <your forked version of bel>
+
+The following commands sets up a virtual environment, installs *bel* as an editable package and then pip installs the requirements.txt packages.
+
+    make dev_install
+
+To run the tests
+
+    make tests
 
-File :project:`.editorconfig`
diff --git a/requirements.txt b/requirements.txt
@@ -21,6 +21,7 @@ sphinx-autobuild==0.7.1
 sphinx-autodoc-typehints==1.2.3
 sphinx-click==1.0.4
 sphinx-rtd-theme==0.2.4
+sphinxcontrib-gravatar==0.1.2
 TatSu==4.2.5
 timy==0.4.0
 twine==1.9.1