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

Support MyST in docstrings with sphinx-autodoc2 #118

Open
Tracked by #202
redeboer opened this issue Mar 1, 2023 · 0 comments
Open
Tracked by #202

Support MyST in docstrings with sphinx-autodoc2 #118

redeboer opened this issue Mar 1, 2023 · 0 comments
Labels
🖱️ DX Improvements to the Developer Experience 🔨 Maintenance Maintenance and upkeep improvements

Comments

@redeboer
Copy link
Member

redeboer commented Mar 1, 2023

Need to investigate whether sphinx-autodoc2 is a suitable replacement of sphinx.ext.autodoc, which we currently use. The fact that sphinx-autodoc2 does not perform dynamical analysis could result in differences in the API.

See here fore more info:

See also #61

@redeboer redeboer added 🔨 Maintenance Maintenance and upkeep improvements 🖱️ DX Improvements to the Developer Experience labels Mar 1, 2023
@redeboer redeboer self-assigned this Mar 1, 2023
@redeboer redeboer removed their assignment Jan 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🖱️ DX Improvements to the Developer Experience 🔨 Maintenance Maintenance and upkeep improvements
Projects
None yet
Development

No branches or pull requests

1 participant