Skip to content

Move sphinx into main requirements #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 18, 2020
Merged

Move sphinx into main requirements #170

merged 1 commit into from
Jun 18, 2020

Conversation

chrisjsewell
Copy link
Member

Sphinx was originally set as an extra requirement, when myst-parser contained plugins for the markdown parser. This is no longer the case, so it is now not likely that the package would be used without sphinx, and just overcomplicates things to have to install myst-parser[sphinx], rather than just myst-parser.
Note the sphinx extra has been left in (as an empty list) so that existing requirements files do not break.

@chrisjsewell chrisjsewell requested a review from choldgraf June 18, 2020 06:32
@codecov
Copy link

codecov bot commented Jun 18, 2020

Codecov Report

Merging #170 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #170   +/-   ##
=======================================
  Coverage   92.02%   92.02%           
=======================================
  Files          10       10           
  Lines        1104     1104           
=======================================
  Hits         1016     1016           
  Misses         88       88           
Flag Coverage Δ
#pytests 92.02% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 181e921...72c6e29. Read the comment docs.

@chrisjsewell
Copy link
Member Author

Note the sphinx extra has been left in (as an empty list) so that existing requirements files do not break.

That being said, we may still want to release this as a new major version (i.e. 0.9.0); in case it does cause any installation issues

@chrisjsewell chrisjsewell linked an issue Jun 18, 2020 that may be closed by this pull request
@choldgraf choldgraf merged commit e681aa5 into master Jun 18, 2020
@choldgraf choldgraf deleted the sphinx-requirement branch June 18, 2020 15:15
@choldgraf
Copy link
Member

nice - good catch

andersk added a commit to andersk/sphinx-extensions that referenced this pull request Jul 6, 2022
Upstream moved Sphinx into the main requirements in 0.9.0
(executablebooks/MyST-Parser#170).

Signed-off-by: Anders Kaseorg <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Usage with RTD - sphinx>=2 requirement was optional?
2 participants