Skip to content

Please Add Support for sphinx extensions #633

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

Open
adam-grant-hendry opened this issue Oct 19, 2022 · 2 comments
Open

Please Add Support for sphinx extensions #633

adam-grant-hendry opened this issue Oct 19, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@adam-grant-hendry
Copy link

adam-grant-hendry commented Oct 19, 2022

Context

Several sphinx extensions are used in older restructured text projects, like;

and several others. Lacking support for these prevents other project from transitioning towards using myst-parser.

e.g. I will not switch over whilst these extensions are unavailable. I am able to achieve more by using restructured text, and these are still able to be used with the sphinx-themes.org themes.

Proposal

The proposal is to add extended support for sphinx extensions to the Sphinx parser in myst-parser.

Tasks and updates

TBD

@adam-grant-hendry adam-grant-hendry added the enhancement New feature or request label Oct 19, 2022
@chrisjsewell
Copy link
Member

Hey @adam-grant-hendry I'm not sure what you mean here; you can use any extension alongside myst-parser, as indeed is the case for the building of the documentation here:

extensions = [

Is there a particular issue you have with compatibility on a certain extension?

@adam-grant-hendry
Copy link
Author

Hi @chrisjsewell,

Ah, perhaps I misunderstood: the numpydocs documentation details using rst-style directives, so I wasn't sure if there would be a conflict with using rst-style directives in docstrings if I wanted to use myst-parser syntax in my documentation files...?

One thing for certain that would be excellent is support for adding/specifying 3rd-party MarkdownIt plugins via the conf.py (Issue #632).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants