Skip to content

Conversation

@radiantly
Copy link

@radiantly radiantly commented Oct 1, 2021

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

Other changes:
- removed m2r package as it is no longer required
- remove monkey patches related to m2r
- bump copyright year to 2021
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

Changes:
- Switch m2r for MyST-Parser
- Update docutils to 0.17 for the parser directive
@radiantly
Copy link
Author

radiantly commented Oct 1, 2021

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.

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!

@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

Labels

None yet

Development

Successfully merging this pull request may close these issues.

recommonmark is deprecated

3 participants