Fix development install instructions (#43)

executablebooks · Feb 15, 2020 · 0e93463 · 0e93463
1 parent 1ec0177
commit 0e93463
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,16 @@ An extended commonmark compliant parser, with bridges to docutils & sphinx.
 ## Usage
 
 ```console
-pip install -e git+https://github.com/ExecutableBookProject/myst_parser.git#egg=myst_parser[sphinx,code_style,testing]
+pip install -e git+https://github.com/ExecutableBookProject/myst_parser.git#egg=myst_parser[sphinx]
+```
+
+Or for package development:
+
+```bash
+git clone https://github.com/ExecutableBookProject/myst_parser
+cd myst_parser
+git checkout develop
+pip install -e .[sphinx,code_style,testing,rtd]
 ```
 
 Note, this parser currently requires the [ExecutableBookProject/mistletoe](https://github.com/ExecutableBookProject/mistletoe)

diff --git a/docs/index.md b/docs/index.md
@@ -17,9 +17,9 @@ pip install -e "git+https://github.com/ExecutableBookProject/myst_parser.git#egg
 Or for package development:
 
 ```bash
-git clone https://github.com/chrisjsewell/mistletoe
-cd mistletoe
-git checkout myst
+git clone https://github.com/ExecutableBookProject/myst_parser
+cd myst_parser
+git checkout develop
 pip install -e .[sphinx,code_style,testing,rtd]
 ```