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
It would be very helpful if we could enable automatic intersphinx references in all code snippets (doctest-style snippets in method docstrings and rST blocks like .. code-block:: python).
I don't currently know of a way to do this, but it may be possible with sphinx-gallery or another tool.
The text was updated successfully, but these errors were encountered:
I added sphinx-codeautolink to signac-dashboard. I found that it wasn't as helpful for signac or signac-flow. The structure of our docs and their code examples is pretty incomplete, meaning that there aren't many (any?) helpful links. We would need to revise the documentation examples to be fully executable snippets (including imports, etc.) in order to see a benefit from this.
Issue Description
The sphinx-gallery package automatically adds intersphinx references to all Jupyter notebooks / input files that it renders. Example: https://sphinx-gallery.github.io/stable/configuration.html#link-to-documentation
It would be very helpful if we could enable automatic intersphinx references in all code snippets (doctest-style snippets in method docstrings and rST blocks like
.. code-block:: python
).I don't currently know of a way to do this, but it may be possible with sphinx-gallery or another tool.
The text was updated successfully, but these errors were encountered: