Support use of autodoc with myst
See original GitHub issueEdit:
The implementation of eval-rst
has now been closed (see this documentation section)
However, a new issue has also been opened, specifically for using Markdown in docstrings: #228
I can’t figure out how to use autodoc with myst.
With recommonmark, I have something like
```eval_rst
.. autofunction:: functionname
```
or
```eval_rst
.. autoclass:: classname
:members:
```
Based on on the myst docs. I can’t figure out what to use to make it work in myst.
(by the way, the example at https://myst-parser.readthedocs.io/en/latest/using/syntax.html#extended-block-tokens, doesn’t seem to agree with the example at https://myst-parser.readthedocs.io/en/latest/using/syntax.html#syntax-directives).
After many attempts at the syntax, I finally got something that at least produced some output. But all it seems to do is inline raw rst instead of rendering it.
Issue Analytics
- State:
- Created 3 years ago
- Reactions:5
- Comments:29 (24 by maintainers)
Top GitHub Comments
Yeah,
eval_rst
seems like a good start, and will probably be handy for other situations in the future. It seems like we are quite far from my dream of markdown docstrings.Closed in v0.12.2 😄 See https://myst-parser.readthedocs.io/en/latest/using/howto.html#use-sphinx-ext-autodoc-in-markdown-files