docs: [FC-0074] reference main hooks docs to maintain DRY docs (#233)

openedx · Dec 9, 2024 · b8c5409 · b8c5409
1 parent 7f6d2c9
commit b8c5409
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 1 deletion.
diff --git a/docs/concepts/openedx-filters.rst b/docs/concepts/openedx-filters.rst
@@ -4,7 +4,7 @@ Open edX Filters
 Overview
 --------
 
-Open edX filters provide a mechanism for modifying the platform's behavior by altering runtime data or halting execution based on specific conditions. Filters allow developers to implement application flow control based on their business logic or requirements without directly modifying the application code.
+As mentioned in the :doc:`docs.openedx.org:developers/concepts/hooks_extension_framework` docs, Open edX filters provide a mechanism for modifying the platform's behavior by altering runtime data or halting execution based on specific conditions. Filters allow developers to implement application flow control based on their business logic or requirements without directly modifying the application code.
 
 Throughout this document, we will refer to Open edX Filters as filters interchangeably.
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -11,6 +11,7 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import os
+import re
 import sys
 sys.path.insert(0, os.path.abspath('..'))
 
@@ -36,6 +37,7 @@
     'sphinxcontrib.mermaid',
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -117,3 +119,18 @@
     html_context["READTHEDOCS"] = True
 
 # -- Extension configuration -------------------------------------------------
+
+# 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"
+
+intersphinx_mapping = {
+    "docs.openedx.org": (
+        f"https://docs.openedx.org/{rtd_language}/{rtd_version}",
+        None,
+    ),
+}
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,8 @@
 Welcome to Open edX Filters's documentation!
 ============================================
 
+Open edX Filters is a type of hook in the Hooks Extension Framework that allows extending the Open edX platform in a more stable and maintainable way. If you're new to this approach for extending Open edX, start by reading the :doc:`docs.openedx.org:developers/concepts/hooks_extension_framework` documentation. This documentation provides an overview of the framework's concepts and structure useful to support your adoption of Open edX Filters.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents: