spatialaudio / nbsphinx

:ledger: Sphinx source parser for Jupyter notebooks
https://nbsphinx.readthedocs.io/
MIT License
449 stars 128 forks source link

Link documented package code in notebooks to Docs #718

Closed a-r-j closed 1 year ago

a-r-j commented 1 year ago

Hiya,

Thanks for this awesome utility! I've really enjoyed it using it in my projects :)

I was wondering if it's possible to automagically link imports (or function calls/objects) from the documented library in notebook code cells to the standard sphinx API documentation. I think it would be really nice for users reading documentation notebooks so they can flip back and forth between the notebook and the documentation.

I see this is possible by using raw cells in reST format. Is there any easy way to force nbsphinx to do this conversion or do I have to change this within the notebooks?

a-r-j commented 1 year ago

Solved with https://github.com/felix-hilden/sphinx-codeautolink