Skip to content

Instantly share code, notes, and snippets.

@felixvd

felixvd/autodoc-myst-parser-bug.md

Created June 15, 2022 07:11
Show Gist options
  • Save felixvd/b0dcd903d95dd480d1a6c4800f191991 to your computer and use it in GitHub Desktop.
Save felixvd/b0dcd903d95dd480d1a6c4800f191991 to your computer and use it in GitHub Desktop.
Download ZIP
Content to reproduce a bug in MyST-Parser
Raw
autodoc-myst-parser-bug.md

With rST

This command will be rendered normally:

.. autoclass:: sphinx.util.docfields.Field
    :members:
    :noindex:

With Markdown

This command would complain that members is unknown if it was included normally, and will not be formatted correctly regardless:

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