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

docs: use myst-parser for markdown #373

Merged
merged 1 commit into from
Aug 11, 2024

Conversation

ReenigneArcher
Copy link
Member

@ReenigneArcher ReenigneArcher commented Jul 28, 2024

Description

Use myst-parser instead of m2r2 for markdown files in docs. m2r2 is no longer maintained, see CrossNox/m2r2#68

Todo:

  • Use this in other repos that use m2r2

Screenshot

Issues Fixed or Closed

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Dependency update (updates to dependencies)
  • Documentation update (changes to documentation)
  • Repository update (changes to repository files, e.g. .github/...)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

@ReenigneArcher ReenigneArcher force-pushed the docs-use-myst-parser-for-markdown branch from cd9f639 to d50cbf2 Compare August 11, 2024 21:39
Copy link

sonarcloud bot commented Aug 11, 2024

@ReenigneArcher ReenigneArcher marked this pull request as ready for review August 11, 2024 21:40
@ReenigneArcher ReenigneArcher merged commit b575469 into master Aug 11, 2024
14 checks passed
@ReenigneArcher ReenigneArcher deleted the docs-use-myst-parser-for-markdown branch August 11, 2024 21:43
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.

1 participant