Skip to content

[Doc]: Fix version switcher in devdocs #27876

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.

Sign up for GitHub

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

Jump to bottom
Closed
dstansby opened this issue Mar 7, 2024 · 2 comments · Fixed by #27886
Closed

[Doc]: Fix version switcher in devdocs #27876

dstansby opened this issue Mar 7, 2024 · 2 comments · Fixed by #27886
Labels
Documentation
Milestone
v3.9.0

Comments

@dstansby
Copy link
Member

dstansby commented Mar 7, 2024

Documentation Link

https://matplotlib.org/devdocs/

Problem

In #27658 I updated the version switcher JSON link so it came from the circleCI builds when building on circleCI. It seems like https://matplotlib.org/devdocs/ is now trying to load a version switcher from circleCI too, so we need to:

  1. Work out how to detect if deploying to devdocs
  2. Set the version switcher URL in docs/conf.py correctly if this is the case

Suggested improvement

No response
@QuLogic
Copy link
Member

QuLogic commented Mar 7, 2024

The condition is here:

matplotlib/.circleci/deploy-docs.sh

Lines 5 to 13 in 0da2da0

if [ "$CIRCLE_PROJECT_USERNAME" != "matplotlib" ] || \
[ "$CIRCLE_BRANCH" != "main" ] || \
[[ "$CIRCLE_PULL_REQUEST" == https://github.com/matplotlib/matplotlib/pull/* ]]; then
echo "Not uploading docs for ${CIRCLE_SHA1}"\
"from non-main branch (${CIRCLE_BRANCH})"\
"or pull request (${CIRCLE_PULL_REQUEST})"\
"or non-Matplotlib org (${CIRCLE_PROJECT_USERNAME})."
exit
fi

@QuLogic QuLogic added this to the v3.9.0 milestone Mar 7, 2024
This was referenced Mar 8, 2024
Closed
Merged
@dstansby
Copy link
Member Author

dstansby commented Mar 8, 2024

Looks like it worked 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.9.0
Development

Successfully merging a pull request may close this issue.

Fix devdocs version switcher dstansby/matplotlib
2 participants
@QuLogic @dstansby