docs: [FC-0074] reference main hooks docs (#424)

openedx · Nov 26, 2024 · a60bcfb · a60bcfb
1 parent 328fe14
commit a60bcfb
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
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 @@
     'sphinx.ext.graphviz',
     'sphinxcontrib.mermaid',
     'code_annotations.contrib.sphinx.extensions.openedx_events',
+    'sphinx.ext.intersphinx',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -115,3 +117,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 Events' documentation!
 ============================================
 
+Open edX Events is 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 Events.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:

diff --git a/docs/reference/real-life-use-cases.rst b/docs/reference/real-life-use-cases.rst
@@ -4,9 +4,7 @@ Real-Life Use Cases for Open edX Events
 Overview
 --------
 
-As mentioned in the Hooks Extension Framework overview, Open edX Events can be used to integrate application components with each other or with external services, allowing them to communicate, synchronize, and perform additional actions when specific triggers occur.
-
-.. TODO: add cross-reference to Hooks Extension Framework after PR is merged docs.openedx.org/pull/599
+As mentioned in the :doc:`docs.openedx.org:developers/concepts/hooks_extension_framework` docs, Open edX Events can be used to integrate application components with each other or with external services, allowing them to communicate, synchronize, and perform additional actions when specific triggers occur.
 
 To illustrate the different solutions that can be implemented with this approach, we have compiled a list of use cases built using Open edX Events to address various challenges. The goal of this list is to serve as a reference for extension developers to implement their own solutions in their own plugins or IDAs based on the community's experience.