Skip to content

remove M2R as dep #527

@lwasser

Description

@lwasser

M2r converts markdown to rst. however it's currently unmaintained and there is a bug related to the new version of sphinx. we only use it to convert our changelog to print in the docs. One quick fix would be to simply link to the changelog in the release notes rst file. We could then completely drop m2r. an alternative is to convert the changelog to .rst and the readme which could work but would take a bit more time.

regardless we should not depend upon m2r anymore given there is a fix but it's unmaintained so it's just not worth using. i'm looking for input from @mbjoseph and @nkorinek on which direction we should go.

  1. convert all files to .rst format (changlog and maybe the readme)
  2. link to files on github in md format and NOT print them as include files in the docs like this:

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions