Repository navigation
Intersphinx references in code snippets #103
Description
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.
Activity
redeboer commentedon Jan 30, 2022
Incidentally ran into this issue while googling. Seems that the new sphinx-codeautolink does the job!
bdice commentedon Jan 30, 2022
@redeboer Wow! Thanks for letting us know! I will give it a try!
bdice commentedon Apr 23, 2022
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.