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.

Sign up for GitHub

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

Jump to bottom

Replace deprecated recommonmark with MyST-Parser #1089

Closed
wants to merge 2 commits into from
Closed

Replace deprecated recommonmark with MyST-Parser #1089

wants to merge 2 commits into from

Conversation

radiantly
Copy link

@radiantly radiantly commented Oct 1, 2021 •
edited
Loading

I have made things!

Docs generation now uses MyST-Parser instead of the deprecated recommonmark to parse .md files.

Other changes:

  • removed m2r package as it is no longer required
  • remove monkey patches relating to m2r
  • bump copyright year to 2021

Checklist

  • I have double checked that there are no unrelated changes in this pull request (old patches, accidental config files, etc)
  • I have created at least one test case for the changes I have made
  • I have updated the documentation for the changes I have made
  • I have added my changes to the CHANGELOG.md

Related issues

Closes #1082

@radiantly
Replace deprecated recommonmark with MyST-Parser
6b6694d 
Other changes:
- removed m2r package as it is no longer required
- remove monkey patches related to m2r
- bump copyright year to 2021
sobolevn
sobolevn requested changes Oct 1, 2021
View reviewed changes
Copy link
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

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

Thanks! We also need to remove this from pyproject.toml and poetry.lock

@radiantly
Update pyproject.toml and poetry.lock
49b5131 
Changes:
- Switch m2r for MyST-Parser
- Update docutils to 0.17 for the parser directive
@radiantly
Copy link
Author

radiantly commented Oct 1, 2021 •
edited
Loading

Done, but I think there's a bit of an issue when running doc8 - however, sphinx builds perfectly, so I'm not sure what exactly the problem is.

sobolevn
sobolevn approved these changes Oct 1, 2021
View reviewed changes
Copy link
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

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

Thanks!

@sobolevn sobolevn mentioned this pull request Oct 3, 2021
Open
4 tasks
@thepabloaguilar
Copy link
Member

Closing this PR since #1082 have been resolved!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sobolevn sobolevn sobolevn approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

recommonmark is deprecated
3 participants
@radiantly @thepabloaguilar @sobolevn