-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
added links to px.data and px.colors in API doc #2493
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
In your screenshot it's listed as |
Re colors, can we list the submodules of Maybe we could list the |
If I had a function that outputted the color scales and sequences by namespace, could we execute that function and inline the output here? |
So if you want it to appear as |
So this CI failure is very frustrating. I created subpackages |
I removed the re-direction for failed builds of notebooks because the output is full of unicode characters which are hard to read but I'll put this back. |
ok I can reproduce the error if I try to install the package with |
4e65c53
to
5776a1f
Compare
ok, silly me, it was just a question of adding the new subpackages to the |
doc/apidoc/Makefile
Outdated
@@ -22,7 +22,7 @@ help: | |||
sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*.py | |||
sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*/*.py | |||
sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*/*/*.py | |||
sphinx-apidoc -o generated ../../packages/python/plotly/plotly ../../packages/python/plotly/plotly/validators ../../packages/python/plotly/plotly/tests ../../packages/python/plotly/plotly/matplotlylib/ ../../packages/python/plotly/plotly/offline ../../packages/python/plotly/plotly/api | |||
sphinx-apidoc -E -M -o generated ../../packages/python/plotly/plotly ../../packages/python/plotly/plotly/validators ../../packages/python/plotly/plotly/tests ../../packages/python/plotly/plotly/matplotlylib/ ../../packages/python/plotly/plotly/offline ../../packages/python/plotly/plotly/api |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These changes:
- remove titles such as "List of modules" which I deemed to be verbose and not helpful.
- put the module content before the list of submodules
I updated the screenshots above. |
@jonmmease could you give these package manipulations a once-over plz? They seem fine to me but I’m always wary of breaking something :) |
It all looks reasonable to me! |
Should be good to merge tomorrow right before the release... thanks @emmanuelle ! |
Co-authored-by: Nicolas Kruchten <nicolas@plot.ly>
I made the small requested changes, please tell me if I can merge! |
💃 |
This PR add links to
px.data
andpx.colors
at the end of the API doc page on plotly.express.For
px.data
For
px.colors
, the objects which we want to list are not functions but lists, and they are not listed in an__all__
somewhere already so I figured out it would be easier to link to the corresponding doc tutorials.In the main

px
page: