I'm currently moving our tutorial notebooks/documentation from RST with jupyter-sphinx to Markdown with myst-nb. We'd eventually like to also move docstrings to be written in myst-markdown. To that end I'm now looking at what I actually need from sphinx-autoapi to make that possible. I came up with this:
- Cast the existing templates into Markdown. Includes using a (potential)
sphinx.util.docstrings.prepare_docstring analog from myst. This is to allow two sets of default templates to exist.
- Make the hardcoded
'*.rst' instances in template loading/rendering (mappers/base.py) use some config value instead. The actual file output suffix is already (not really explicitly) configurable.
I'd be happy to contribute this. If I was to do this just for our project, I'd still have to do step 1., but keep the .rst filenames. And step 2. seems pretty trivial.
What do you think?
I'm currently moving our tutorial notebooks/documentation from RST with
jupyter-sphinxto Markdown withmyst-nb. We'd eventually like to also move docstrings to be written in myst-markdown. To that end I'm now looking at what I actually need fromsphinx-autoapito make that possible. I came up with this:sphinx.util.docstrings.prepare_docstringanalog from myst. This is to allow two sets of default templates to exist.'*.rst'instances in template loading/rendering (mappers/base.py) use some config value instead. The actual file output suffix is already (not really explicitly) configurable.I'd be happy to contribute this. If I was to do this just for our project, I'd still have to do step 1., but keep the
.rstfilenames. And step 2. seems pretty trivial.What do you think?