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.

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

Insert formulas in docstrings with MyST substitutions #202

Open
1 task
redeboer opened this issue Jan 11, 2022 · 0 comments
Open
1 task

Insert formulas in docstrings with MyST substitutions #202

redeboer opened this issue Jan 11, 2022 · 0 comments
Labels
📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience

Comments

@redeboer
Copy link
Member

redeboer commented Jan 11, 2022 •
edited
Loading

Formulas in the API are currently generated with an 'extension' of conf.py, extend_docstrings.py. This is not ideal and it's easy to forget to update things there once parts of the API change. Ideal would be to use myst_substitutions (here in conf.py), but this does not seem to work well with sphinx-apidoc.

Requirements
Preview Give feedback
  1. Support MyST in docstrings with sphinx-autodoc2 repo-maintenance#118
    🔨 Maintenance 🖱️ DX
@redeboer redeboer added 📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience labels Jan 11, 2022
@redeboer redeboer changed the title Insert formulas in docstrings with myst substitutions Insert formulas in docstrings with MyST substitutions Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@redeboer