Skip to content

Commit

Permalink
Improve package install for mistletoe (#15)
Browse files Browse the repository at this point in the history
- Specify github fork in `setup_requires`
- Update .travis.yml
- Remove docs/requirements.txt
  • Loading branch information
chrisjsewell committed Feb 13, 2020
1 parent bcb39b6 commit 58ad837
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 12 deletions.
1 change: 0 additions & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ jobs:
- restore_cache:
keys:
- cache-pip
- run: pip install --user -r docs/requirements.txt
- run: pip install --user -e .[testing,sphinx]
- save_cache:
key: cache-pip
Expand Down
8 changes: 5 additions & 3 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
name: Myst Parser
type: sphinx
requirements_file: docs/requirements.txt

python:
version: 3
install:
- method: pip
path: .
- method: pip
path: .
extra_requirements:
- sphinx
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ matrix:
env: TEST_TYPE="pre-commit"
install:
- pip install --upgrade pip wheel setuptools
- pip install git+https://github.com/ExecutableBookProject/mistletoe.git@myst
- |
if [[ "$TEST_TYPE" == "pre-commit" ]]; then
pip install -e .[code_style]
fi
- |
if [[ "$TEST_TYPE" == "pytest" ]]; then
pip install -e .[testing,sphinx]
pip install coveralls
fi
before_script:
- (cd tests/commonmark && ./spec.sh)
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# myst_parser

[![Build Status](https://travis-ci.org/ExecutableBookProject/myst_parser.svg?branch=master)](https://travis-ci.org/ExecutableBookProject/myst_parser)
[![Coverage Status](https://coveralls.io/repos/github/ExecutableBookProject/myst_parser/badge.svg?branch=improvements)](https://coveralls.io/github/ExecutableBookProject/myst_parser?branch=improvements)
[![Documentation Status](https://readthedocs.org/projects/myst-parser/badge/?version=latest)](https://myst-parser.readthedocs.io/en/latest/?badge=latest)

An extended commonmark compliant parser, with bridges to docutils & sphinx.

## Installing
## Usage

This parser currently requires the [ExecutableBookProject/mistletoe](https://github.com/ExecutableBookProject/mistletoe)
fork of mistletoe (and the myst branch).
Expand Down
3 changes: 0 additions & 3 deletions docs/requirements.txt

This file was deleted.

11 changes: 8 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,12 @@
],
keywords="markdown lexer parser development docutils sphinx",
python_requires=">=3.5",
install_requires=["mistletoe>=0.8"],
install_requires=[
(
"mistletoe @ "
"https://github.com/ExecutableBookProject/mistletoe/archive/myst.zip"
)
],
extras_require={
"code_style": ["flake8<3.8.0,>=3.7.0", "black", "pre-commit==1.17.0"],
"testing": [
Expand All @@ -43,7 +48,7 @@
"pytest-regressions",
"beautifulsoup4",
],
"sphinx": ["docutils>=0.15", "sphinx>=2,<3"],
"sphinx": ["pyyaml", "docutils>=0.15", "sphinx>=2,<3"],
},
zip_safe=False,
zip_safe=True,
)

0 comments on commit 58ad837

Please sign in to comment.