Skip to content
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

build: Update intersphinx mapping #2318

Merged
merged 3 commits into from
Feb 13, 2025
Merged

build: Update intersphinx mapping #2318

merged 3 commits into from
Feb 13, 2025

Conversation

sarina
Copy link
Contributor

@sarina sarina commented Feb 11, 2025

@feanil - I saw you did this for the XBlock docs, so I figured I should do it for other docs that have moved. However I'm not sure what else I need to do to effect redirects. Note we are also currently in the process of moving the OLX docs (openedx/docs.openedx.org#819)

Copy link
Contributor

@feanil feanil left a comment

Choose a reason for hiding this comment

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

You shouldn't point to the index.html but to the en/latest url because intersphinx builds a URL on top of that to find the inventory files that are generated as a part of docs builds.

@sarina
Copy link
Contributor Author

sarina commented Feb 11, 2025

@sarina
Copy link
Contributor Author

sarina commented Feb 12, 2025

So, I'm getting a million build failures related to missing labels, and I'm going to assume a part of that is that when we moved docs, we changed a number of the labels....

@sarina sarina force-pushed the update-urls-redirects branch from 0973b57 to 856acc3 Compare February 12, 2025 21:27
@sarina
Copy link
Contributor Author

sarina commented Feb 12, 2025

@feanil this is ready to go. I'll open up separate PRs to figure out the redirects for the open edx course staff docs and eventually the OLX docs once openedx/docs.openedx.org#819 is merged

@@ -209,19 +209,19 @@ def ism_location(dir_name):
return None

intersphinx_mapping = {
"opencoursestaff" : (openedx_rtd_url("open-edx-building-and-running-a-course"), ism_location("open_edx_course_authors")),
"opencoursestaff" : ("https://docs.openedx.org/en/latest/", None),
Copy link
Contributor

Choose a reason for hiding this comment

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

FYI, this is because you set the second parameter to None that you had to update all the prefixes. Not something you need to fix but for future reference.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ah gotcha, ty!

@sarina
Copy link
Contributor Author

sarina commented Feb 13, 2025

Relates to #2319

@sarina sarina merged commit c6d9b45 into master Feb 13, 2025
9 checks passed
@sarina sarina deleted the update-urls-redirects branch February 13, 2025 17:22
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