[Doc]: Fix version switcher in devdocs · Issue #27876 · matplotlib/matplotlib · GitHub

Documentation Link

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:

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

Suggested improvement

No response

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

Looks like it worked 🎉

[Doc]: Fix version switcher in devdocs · Issue #27876 · matplotlib/matplotlib · GitHub

Repository navigation

[Doc]: Fix version switcher in devdocs #27876

Documentation Link

Problem

Suggested improvement

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	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

[Doc]: Fix version switcher in devdocs · Issue #27876 · matplotlib/matplotlib · GitHub

Repository navigation

[Doc]: Fix version switcher in devdocs #27876

Description

Documentation Link

Problem

Suggested improvement

Activity

QuLogic commented on Mar 7, 2024

dstansby commented on Mar 8, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions