question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Support use of autodoc with myst

See original GitHub issue

Edit:

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:closed
  • Created 3 years ago
  • Reactions:5
  • Comments:29 (24 by maintainers)

github_iconTop GitHub Comments

3reactions
sblivencommented, Aug 2, 2020

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.

Read more comments on GitHub >

github_iconTop Results From Across the Web

FAQ - MyST-Parser - Read the Docs
To include a MyST file within a ReStructuredText file, we can use the parser ... The Sphinx extension autodoc , which pulls in...
Read more >
Force Sphinx to interpret Markdown with MyST in Python ...
I'm rookie with Sphinx, and I was trying to figure out how to use MyST parser for sphinx to make it work with...
Read more >
MyST Markdown overview - Jupyter Book
MyST supports all syntax of CommonMark Markdown (the kind of Markdown that Jupyter notebooks use), as well as an extended syntax that is...
Read more >
Sample episode in MyST Markdown — Sphinx-lesson ...
... document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the #...
Read more >
master PDF - Sphinx Documentation
sphinx.ext.napoleon – Support for NumPy and Google style docstrings . ... In order to use autodoc, you need to activate it in conf.py...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found