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 recently have been working on a book that uses Autodoc to create API documentation. I've used Sphinx quite a bit in the past, so I was looking for a way to reference the Python namespace (i.e. :py:mod:`mymodule`) from my Markdown files in the rest of the book. I tried a few things ({py.mod}, {mod}, {py-mod}) until I found that this works ({py:mod}`mymodule`). However, I have not found this mentioned in the docs and I think it would be a really good addition to https://jupyterbook.org/en/stable/content/references.html.
Have I missed this somewhere? Is this considered obvious information? If not, I'm happy to propose an addition to the documentation.
Additionally, is it the general case that Jupyter Book replaces the leading and trailing brackets with colons to go from markdown to rst? For example, would these all work:
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
-
I recently have been working on a book that uses Autodoc to create API documentation. I've used Sphinx quite a bit in the past, so I was looking for a way to reference the Python namespace (i.e.
:py:mod:`mymodule`
) from my Markdown files in the rest of the book. I tried a few things ({py.mod}
,{mod}
,{py-mod}
) until I found that this works ({py:mod}`mymodule`
). However, I have not found this mentioned in the docs and I think it would be a really good addition to https://jupyterbook.org/en/stable/content/references.html.Have I missed this somewhere? Is this considered obvious information? If not, I'm happy to propose an addition to the documentation.
Additionally, is it the general case that Jupyter Book replaces the leading and trailing brackets with colons to go from markdown to rst? For example, would these all work:
Beta Was this translation helpful? Give feedback.
All reactions