Skip to content

doc: m2r2->myst #647

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
Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

doc: m2r2->myst #647

wants to merge 1 commit into from

Conversation

dweindl
Copy link
Member

@dweindl dweindl commented Aug 20, 2025 •
edited
Loading

Use myst-parser instead of m2r2.

Fixes the following warning when building docs:

lib/python3.13/site-packages/m2r2.py:20: UserWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html. The pkg_resources package is slated for removal as early as 2025-11-30. Refrain from using this package or pin to Setuptools<81.
  from pkg_resources import get_distribution
  • We also need md->rst outside sphinx for the README which does not work with myst

@dweindl
doc: m2r2->myst
12b166e 
Use `myst-parser` instead of `m2r2`.

Fixes the following warning when building docs:
```
lib/python3.13/site-packages/m2r2.py:20: UserWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html. The pkg_resources package is slated for removal as early as 2025-11-30. Refrain from using this package or pin to Setuptools<81.
  from pkg_resources import get_distribution
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@dweindl