Finalize the install process and make a note about it.

pauleveritt · Mar 7, 2020 · e4033b2 · e4033b2
1 parent 608ab02
commit e4033b2
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -34,6 +34,22 @@ html("""
 
 ## Development
 
+To install locally:
+
+```shell script
+$ pip install -e .
+```
+
+If you want to run tests and build the Sphinx docs and their examples...that runs into [a problem with hyperpython's transitive dependencies](https://github.com/ejplatform/hyperpython/issues/4).
+Thus: 
+
+```shell script
+$ pip install toolz
+$ pip install sidekick
+$ pip install -e .[docs]
+```
+
+
 ### Running Tests
 
 ```sh

diff --git a/TODO.md b/TODO.md
diff --git a/hyperpython_requirements.txt b/hyperpython_requirements.txt
@@ -1,2 +1 @@
--r sidekick_requirements.txt
 sidekick
diff --git a/readthedocs.yaml b/readthedocs.yaml
@@ -7,6 +7,7 @@ sphinx:
 python:
   version: 3.8
   install:
+    - requirements: sidekick_requirements.txt
     - requirements: hyperpython_requirements.txt
     - method: pip
       path: .