Not sure whether this issue should be here or in ploty.py, since it depends on the solution.
It would be nice to have links to the API doc https://plot.ly/python-api-reference/ in the code blocks of the Python tutorials, for the classes and functions of plotly.py. This is something that projects using sphinx-gallery do, see for example https://scikit-learn.org/stable/auto_examples/plot_johnson_lindenstrauss_bound.html#sphx-glr-auto-examples-plot-johnson-lindenstrauss-bound-py or https://scikit-image.org/docs/stable/auto_examples/color_exposure/plot_regional_maxima.html#sphx-glr-auto-examples-color-exposure-plot-regional-maxima-py.
For a list of objects which are in the API doc, one can use the objects.inv generated when building the documentation of plotly.py (when doing "make html" in the apidoc directory, the file is in apidoc/_build/html/objects.inv). This file is an index of objects and doc pages, it is a zipped format but a human-readable version can be obtained from
python3 -m sphinx.ext.intersphinx objects.inv
Possible solutions :
- adding a javascript script to generate the links
- or patching nbconvert to generate the links when building the html pages from the md files.
Not sure whether this issue should be here or in
ploty.py, since it depends on the solution.It would be nice to have links to the API doc https://plot.ly/python-api-reference/ in the code blocks of the Python tutorials, for the classes and functions of
plotly.py. This is something that projects using sphinx-gallery do, see for example https://scikit-learn.org/stable/auto_examples/plot_johnson_lindenstrauss_bound.html#sphx-glr-auto-examples-plot-johnson-lindenstrauss-bound-py or https://scikit-image.org/docs/stable/auto_examples/color_exposure/plot_regional_maxima.html#sphx-glr-auto-examples-color-exposure-plot-regional-maxima-py.For a list of objects which are in the API doc, one can use the
objects.invgenerated when building the documentation of plotly.py (when doing "make html" in theapidocdirectory, the file is inapidoc/_build/html/objects.inv). This file is an index of objects and doc pages, it is a zipped format but a human-readable version can be obtained fromPossible solutions :