Skip to content

Fix broken links #4618

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

Merged
merged 2 commits into from
Jun 7, 2024
Merged

Fix broken links #4618

merged 2 commits into from
Jun 7, 2024

Conversation

LiamConnors
Copy link
Member

We have these links on the reference docs

image

That go here: https://plotly.com/python-api-reference/generated/generated/plotly.graph_objects.Figure.html

But the names in the built api docs are different.

image

https://github.com/plotly/plotly.py-docs/tree/gh-pages/generated/generated

We are renaming everything else to graph_objects except these.

This PR should fix the links, but I need to investigate more why these are in a different directory and if they should be included.

@LiamConnors LiamConnors requested a review from gvwilson May 30, 2024 20:06
@LiamConnors
Copy link
Member Author

Full build failing: #4619
Doesn't seem to be related to this. Has been failing on other PRs

@gvwilson gvwilson mentioned this pull request May 31, 2024
@@ -36,7 +36,7 @@ help:
# Remove files which were added only for docstring generation
rm ../../packages/python/plotly/plotly/colors/diverging.py ../../packages/python/plotly/plotly/colors/sequential.py ../../packages/python/plotly/plotly/colors/qualitative.py ../../packages/python/plotly/plotly/colors/cyclical.py ../../packages/python/plotly/plotly/colors/colorbrewer.py ../../packages/python/plotly/plotly/colors/carto.py ../../packages/python/plotly/plotly/colors/cmocean.py
rm ../../packages/python/plotly/plotly/express/colors/diverging.py ../../packages/python/plotly/plotly/express/colors/sequential.py ../../packages/python/plotly/plotly/express/colors/qualitative.py ../../packages/python/plotly/plotly/express/colors/cyclical.py ../../packages/python/plotly/plotly/express/colors/colorbrewer.py ../../packages/python/plotly/plotly/express/colors/carto.py ../../packages/python/plotly/plotly/express/colors/cmocean.py
rename 's/graph_objs/graph_objects/' _build/html/*.html _build/html/generated/*.html
rename 's/graph_objs/graph_objects/' _build/html/*.html _build/html/generated/*.html _build/html/generated/generated/*.html
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why generated/generated but I trust you :-)

Copy link
Contributor

@gvwilson gvwilson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved pending your decision on whether this can be merged despite #4619.

@LiamConnors
Copy link
Member Author

Approved pending your decision on whether this can be merged despite #4619.

I'll try and fix that first as we'll need to fix it to do the next Plotly.py release

@LiamConnors LiamConnors merged commit 604e31a into doc-prod Jun 7, 2024
5 checks passed
@LiamConnors LiamConnors deleted the fix-broken-links-2 branch June 7, 2024 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants