-
Notifications
You must be signed in to change notification settings - Fork 342
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
Conversation
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.
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.
@feanil okay thanks, how do I point at https://docs.openedx.org/en/latest/educators/index.html? Would I be able to do https://docs.openedx.org/en/latest/educators - or can I only do https://docs.openedx.org/en/latest? |
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.... |
0973b57
to
856acc3
Compare
@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), |
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.
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.
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.
ah gotcha, ty!
Relates to #2319 |
@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)