WIP, Example: using intersphinx to link w/ nx docs.

networkx / nx-guides

Examples and Jupyter Notebooks about NetworkX

https://networkx.org/nx-guides/

Creative Commons Zero v1.0 Universal

188 stars 104 forks source link

WIP, Example: using intersphinx to link w/ nx docs. #31

Closed rossbar closed 2 years ago

rossbar commented 3 years ago

A single example of using MyST markdown features to setup intersphinx for the notebooks site.

The main advantage is that we can use roles+directives+sphinx extensions for the notebooks!

The main disadvantage is that the extended (i.e. non-commonmark) MyST features are not yet supported in Jupyter notebooks. So for users who are using binder and/or running notebooks locally w/ jupyter notebook, the markup will not render properly.

rossbar commented 2 years ago

I'm going to close this since for now since a decision has been made in #32 - we can revisit this idea (and similar) if/when these features are supported in the notebook environment.