-
Notifications
You must be signed in to change notification settings - Fork 197
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
🔧 MAINTAIN: Add publishing job for myst-docutils
#456
Conversation
Codecov Report
@@ Coverage Diff @@
## master #456 +/- ##
=======================================
Coverage 90.32% 90.32%
=======================================
Files 16 16
Lines 1985 1985
=======================================
Hits 1793 1793
Misses 192 192
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
will adapt this slightly once #426 is merged |
myst-docutils
"# MyST-Parser\n\nNote: myst-docutils is identical to myst-parser, " | ||
"but without installation requirements on sphinx", | ||
) | ||
content = content.replace("myst-parser", "myst-docutils") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because of this replacement, the Readme now says "myst-docutils is identical to myst-docutils" 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doh!
This PR adds a workflow for releasing an additional package
myst-docutils
, which does not include install requirements on docutils or sphinx, to close #347 and allow docutils to utilise it in their package with no cyclic dependencies.It does this by simply modifying the
setup.cfg
andREADME.md
before the build.The build is also tested against a range of docutils versions (e.g. to ensure it does not fail due to missing sphinx install)