Skip to content
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

Merged
merged 7 commits into from
Dec 11, 2021

Conversation

chrisjsewell
Copy link
Member

@chrisjsewell chrisjsewell commented Dec 6, 2021

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 and README.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)

@codecov
Copy link

codecov bot commented Dec 6, 2021

Codecov Report

Merging #456 (77b984e) into master (560f641) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #456   +/-   ##
=======================================
  Coverage   90.32%   90.32%           
=======================================
  Files          16       16           
  Lines        1985     1985           
=======================================
  Hits         1793     1793           
  Misses        192      192           
Flag Coverage Δ
pytests 90.32% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


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 560f641...77b984e. Read the comment docs.

@chrisjsewell
Copy link
Member Author

will adapt this slightly once #426 is merged

@chrisjsewell chrisjsewell changed the title 🔧 MAINTAIN: Add publishing job for myst-docutils 🔧 MAINTAIN: Add publishing job for myst-docutils Dec 6, 2021
@chrisjsewell chrisjsewell merged commit 894e8a9 into master Dec 11, 2021
@chrisjsewell chrisjsewell deleted the publish-docutils branch December 11, 2021 03:01
"# MyST-Parser\n\nNote: myst-docutils is identical to myst-parser, "
"but without installation requirements on sphinx",
)
content = content.replace("myst-parser", "myst-docutils")
Copy link
Contributor

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" 😄

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doh!

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.

Split docutils only functionality into separate package
2 participants