Skip to content

docs: Add intersphinx mapping for OEPs #38

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

Merged
sarina merged 1 commit into from
Sep 9, 2025
Merged

docs: Add intersphinx mapping for OEPs #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,6 +513,13 @@ def get_version(*file_paths):
#
# epub_use_index = True

# Intersphinx Extension Configuration
DIGITS_ONLY = r"^\d+$"
rtd_language = os.environ.get("READTHEDOCS_LANGUAGE", "en")
rtd_version = os.environ.get("READTHEDOCS_VERSION", "latest")
if re.search(DIGITS_ONLY, rtd_version):
# This is a PR build, use the latest versions of the other repos.
rtd_version = "latest"

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
Expand All @@ -522,6 +529,12 @@ def get_version(*file_paths):
"https://docs.djangoproject.com/en/3.2/_objects/",
),
"model_utils": ("https://django-model-utils.readthedocs.io/en/latest/", None),
"openedx-proposals": (
# Not setting the version on purpose because we always want the latest version
# of OEPs
f"https://docs.openedx.org/projects/openedx-proposals/{rtd_language}/latest",
None,
),
}


Expand Down
2 changes: 1 addition & 1 deletion docs/decisions/0001-purpose-of-this-repo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ References

- Technical Approach: `AuthZ <https://openedx.atlassian.net/wiki/spaces/OEPM/pages/5176229910>`_
- PRD: `Roles & Permissions <https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4724490259>`_
- OEP-66: `Authorization Best Practices <https://docs.openedx.org/projects/openedx-proposals/en/latest/best-practices/oep-0066-bp-authorization.html>`_
- OEP-66: :ref:`Authorization Best Practices <openedx-proposals:OEP-66 User Authorization>`