Skip to content

Commit

Permalink
chore: [FC-0074] drop hooks docs in favor of latest in docs.openedx.o…
Browse files Browse the repository at this point in the history
…rg (#35921)
  • Loading branch information
mariajgrimaldi authored Dec 11, 2024
1 parent 3e9158e commit f96f926
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 508 deletions.
8 changes: 5 additions & 3 deletions docs/concepts/extension_points.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,10 +139,10 @@ Here are the different integration points that python plugins can use:
- This decorator allows overriding any function or method by pointing to an alternative implementation in settings. Read the |pluggable_override docstring|_ to learn more.
* - Open edX Events
- Adopt, Stable
- Events are part of the greater Hooks Extension Framework for open extension of edx-platform. Events are a stable way for plugin developers to react to learner or author events. They are defined by a `separate events library`_ that developers can include in their requirements to develop and test the code without creating a dependency on this large repo. For more information see the `hooks guide`_.
- Events are part of the greater Hooks Extension Framework for open extension of edx-platform. Events are a stable way for plugin developers to react to learner or author events. They are defined by a `separate events library`_ that developers can include in their requirements to develop and test the code without creating a dependency on this large repo. For more information see the `Hooks Extension Framework docs`_ or for more detailed documentation about Open edX Events, see the `Open edX Events documentation`_.
* - Open edX Filters
- Adopt, Stable
- Filters are also part of Hooks Extension Framework for open extension of edx-platform. Filters are a flexible way for plugin developers to modify learner or author application flows. They are defined by a `separate filters library`_ that developers can include in their requirements to develop and test the code without creating a dependency on this large repo. For more information see the `hooks guide`_.
- Filters are also part of Hooks Extension Framework for open extension of edx-platform. Filters are a flexible way for plugin developers to modify learner or author application flows. They are defined by a `separate filters library`_ that developers can include in their requirements to develop and test the code without creating a dependency on this large repo. For more information see the `Hooks Extension Framework docs`_ or for more detailed documentation about Open edX Filters, see the `Open edX Filters documentation`_.

.. _Application: https://docs.djangoproject.com/en/3.0/ref/applications/
.. _Django app plugin documentation: https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/plugins/README.rst
Expand All @@ -159,7 +159,9 @@ Here are the different integration points that python plugins can use:
.. _pluggable_override docstring: https://github.com/openedx/edx-django-utils/blob/master/edx_django_utils/plugins/pluggable_override.py
.. _separate events library: https://github.com/eduNEXT/openedx-events/
.. _separate filters library: https://github.com/eduNEXT/openedx-filters/
.. _hooks guide: https://github.com/openedx/edx-platform/blob/master/docs/guides/hooks/index.rst
.. _Hooks Extension Framework docs: https://docs.openedx.org/en/latest/developers/concepts/hooks_extension_framework.html
.. _Open edX Events documentation: https://docs.openedx.org/projects/openedx-events/en/latest/
.. _Open edX Filters documentation: https://docs.openedx.org/projects/openedx-filters/en/latest/

Platform Look & Feel
====================
Expand Down
11 changes: 11 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
'code_annotations.contrib.sphinx.extensions.featuretoggles',
'code_annotations.contrib.sphinx.extensions.settings',
# 'autoapi.extension', # Temporarily disabled
'sphinx_reredirects',
]

# Temporarily disabling autoapi_dirs and the AutoAPI extension due to performance issues.
Expand Down Expand Up @@ -304,6 +305,16 @@
# 'xmodule': 'references/docstrings/xmodule',
}

# Mapping permanently moved pages to appropriate new location outside of edx-platform
# with by sphinx-reredirects extension redirects.
# More information: https://documatt.com/sphinx-reredirects/usage.html

redirects = {
'hooks/events': 'https://docs.openedx.org/projects/openedx-events/en/latest/',
'hooks/filters': 'https://docs.openedx.org/projects/openedx-filters/en/latest/',
'hooks/index': 'https://docs.openedx.org/en/latest/developers/concepts/hooks_extension_framework.html',
}


def update_settings_module(service='lms'):
"""
Expand Down
261 changes: 0 additions & 261 deletions docs/hooks/events.rst

This file was deleted.

Loading

0 comments on commit f96f926

Please sign in to comment.