You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'm writing some brief documentation for users on how to use autosummary with myst-parser. To help my users, I've written a brief example in a Markdown code block, like so:
# Title
Some text.
````markdown
```{eval-rst}
.. currentmodule:: my_module
.. autosummary::
:toctree: folder/
hello
world
```
````
The module my_module and its functions hello and world do not exist, as this is just an example.
However, when I build the documentation with Sphinx, it actually executes the autosummary directive, and raises warnings:
WARNING: [autosummary] failed to import 'my_module.hello': no module named my_module.hello
WARNING: [autosummary] failed to import 'my_module.world': no module named my_module.world
Is this the expected behaviour? Or am I doing something wrong?! I would've expected it to skip over the entire {eval-rst} block as it's nested inside a code block. Grateful for any assistance!
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Hi,
I'm writing some brief documentation for users on how to use autosummary with myst-parser. To help my users, I've written a brief example in a Markdown code block, like so:
The module
my_module
and its functionshello
andworld
do not exist, as this is just an example.However, when I build the documentation with Sphinx, it actually executes the autosummary directive, and raises warnings:
Is this the expected behaviour? Or am I doing something wrong?! I would've expected it to skip over the entire
{eval-rst}
block as it's nested inside a code block. Grateful for any assistance!Beta Was this translation helpful? Give feedback.
All reactions