Merge pull request #23 from greschd/improve_docs

Improve installation instructions.
aiidateam · Feb 27, 2020 · 5541e9e · 5541e9e
2 parents aa4fa60 + 4aa540d
commit 5541e9e
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 6 deletions.
diff --git a/docs/source/developer_guide/index.rst b/docs/source/developer_guide/index.rst
@@ -2,6 +2,21 @@
 Developer guide
 ===============
 
+Full setup
+++++++++++
+
+The following commands give you a complete development setup for
+``aiida-testing``.
+Make sure to run this in the appropriate virtual environment::
+
+    git clone https://github.com/aiidateam/aiida-testing.git
+    cd aiida-testing
+    pip install -e .[dev]
+    pre-commit install
+
+Commands to install only parts of the development setup are included
+below.
+
 Running the tests
 +++++++++++++++++
 
@@ -48,6 +63,14 @@ https://aiida-testing.readthedocs.org/.
 If you have a ReadTheDocs account, you can also enable it on your own
 fork for testing, but you will have to use a different name.
 
+Local documentation
++++++++++++++++++++
+
+Of course, you can also build the documentation locally::
+
+    pip install -e .[docs]
+    cd docs
+    make
 
 PyPI release
 ++++++++++++

diff --git a/docs/source/user_guide/get_started.rst b/docs/source/user_guide/get_started.rst
@@ -12,12 +12,6 @@ Use the following commands to install ``aiida-testing``::
 
     pip install aiida-testing
 
-Or, if you want to develop ``aiida-testing``::
-
-    git clone https://github.com/aiidateam/aiida-testing
-    cd aiida-testing
-    pip install -e .
-
 
 Usage
 +++++