Skip to content

Commit

Permalink
Split requirements for RTD documentation build into separate extra (#41)
Browse files Browse the repository at this point in the history
Since these are not core requirements of the Sphinx parser.
  • Loading branch information
chrisjsewell committed Feb 15, 2020
1 parent 8c7c7a7 commit 1ec0177
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
- restore_cache:
keys:
- cache-pip
- run: pip install --user -e .[testing,sphinx]
- run: pip install --user -e .[sphinx,rtd]
- save_cache:
key: cache-pip
paths:
Expand Down
1 change: 1 addition & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ python:
path: .
extra_requirements:
- sphinx
- rtd
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Or for package development:
git clone https://github.com/chrisjsewell/mistletoe
cd mistletoe
git checkout myst
pip install -e .[sphinx,testing]
pip install -e .[sphinx,code_style,testing,rtd]
```

This should install the myst fork of mistletoe, along with the Sphinx parser
Expand Down
9 changes: 2 additions & 7 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
)
],
extras_require={
"sphinx": ["pyyaml", "docutils>=0.15", "sphinx>=2,<3"],
"code_style": ["flake8<3.8.0,>=3.7.0", "black", "pre-commit==1.17.0"],
"testing": [
"coverage",
Expand All @@ -48,13 +49,7 @@
"pytest-regressions",
"beautifulsoup4",
],
"sphinx": [
"pyyaml",
"docutils>=0.15",
"sphinx>=2,<3",
"sphinxcontrib-bibtex",
"ipython",
],
"rtd": ["sphinxcontrib-bibtex", "ipython"],
},
zip_safe=True,
)

0 comments on commit 1ec0177

Please sign in to comment.