fix:Fixed broken link and restructuredtext warnings (#204)

* fix: Fixed broken link and restructuredtext warnings
openedx · May 20, 2022 · 2ddda6f · 2ddda6f
1 parent f162ec4
commit 2ddda6f
Show file tree

Hide file tree

Showing 9 changed files with 16 additions and 30 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -69,24 +69,15 @@ This tag is a re-release of version 3.0.0. (Failed to bump internal version, tho
 [1.0.0] - 2020-11-09
 ~~~~~~~~~~~~~~~~~~~~
 
-Removed
---------
-
 * Dropped support for Python 3.5
 
 [0.2.0] - 2020-11-06
 ~~~~~~~~~~~~~~~~~~~~
 
-Added
-_____
-
 * caliper transformer backend
 * event routing backend
 
 [0.1.0] - 2020-09-22
 ~~~~~~~~~~~~~~~~~~~~
 
-Added
-_____
-
 * First release on PyPI.
diff --git a/README.rst b/README.rst
@@ -35,7 +35,7 @@ How To Contribute
 -----------------
 
 Contributions are very welcome.
-Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.
+Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`__ for details.
 Even though they were written with ``edx-platform`` in mind, the guidelines
 should be followed for all Open edX projects.
 
@@ -57,11 +57,10 @@ If you're having trouble, we have discussion forums at https://discuss.openedx.o
 
 Our real-time conversations are on Slack. You can request a `Slack invitation`_, then join our `community Slack workspace`_.
 
-For more information about these options, see the `Getting Help`_ page.
+For more information about these options, see the `Getting Help <https://openedx.org/getting-help>`__ page.
 
 .. _Slack invitation: https://openedx-slack-invite.herokuapp.com/
 .. _community Slack workspace: https://openedx.slack.com/
-.. _Getting Help: https://openedx.org/getting-help
 
 .. |pypi-badge| image:: https://img.shields.io/pypi/v/event-routing-backends.svg
     :target: https://pypi.python.org/pypi/event-routing-backends/

diff --git a/docs/conf.py b/docs/conf.py
@@ -127,7 +127,7 @@ def get_version(*file_paths):
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'changelog.rst']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.

diff --git a/docs/decisions/0007-access-control-of-events.rst b/docs/decisions/0007-access-control-of-events.rst
@@ -9,7 +9,7 @@ Approved
 Context
 -------
 
-`event-routing-backends` can transform filtered edX events in xAPI and Caliper format which can then be routed to configured URLs. Procedure for configuring URLs of learning record consumers can be found in the `documentation`_. List of supported edX events can be accessed `here`_. A method is required to filter edX events based on event name, course id, organisation id etc. or on any combination of these properties.
+`event-routing-backends` can transform filtered edX events in xAPI and Caliper format which can then be routed to configured URLs. Procedure for configuring URLs of learning record consumers can be found in the :ref:`Installation`. List of supported edX events can be accessed `here`_. A method is required to filter edX events based on event name, course id, organisation id etc. or on any combination of these properties.
 
 Decision
 --------
@@ -55,5 +55,4 @@ Examples
              "enterprise_uuid": "org_XYZ",
              "name": ["edx.course.completed", "edx.course.enrollment.activated"]}
 
-.. _documentation: https://event-routing-backends.readthedocs.io/en/latest/getting_started.html#setup
-.. _here: ../event-mapping/list_of_supported_edx_events.rst
+.. _here: ../event-mapping/Supported_events.rst
diff --git a/docs/event-mapping/Supported_events.rst b/docs/event-mapping/Supported_events.rst
@@ -31,12 +31,12 @@ Video events
 * `edx.video.stopped`_ (legacy name: ``stop_video``) | edX `sample <../../event_routing_backends/processors/tests/fixtures/current/stop_video.json>`__ | xAPI `map <./xAPI_mapping.rst#edx-video-stopped>`__ , `sample <../../event_routing_backends/processors/xapi/tests/fixtures/expected/stop_video.json>`__ | Caliper `map <./Caliper_mapping.rst#edx-video-stopped>`__ , `sample <../../event_routing_backends/processors/caliper/tests/fixtures/expected/stop_video.json>`__
 * `edx.video.paused`_ (legacy name: ``pause_video``) | edX `sample <../../event_routing_backends/processors/tests/fixtures/current/pause_video.json>`__ | xAPI `map <./xAPI_mapping.rst#edx-video-paused>`__ , `sample <../../event_routing_backends/processors/xapi/tests/fixtures/expected/pause_video.json>`__ | Caliper `map <./Caliper_mapping.rst#edx-video-paused>`__ , `sample <../../event_routing_backends/processors/caliper/tests/fixtures/expected/pause_video.json>`__
 * `edx.video.position.changed`_ (legacy name: ``seek_video``) | edX `sample <../../event_routing_backends/processors/tests/fixtures/current/seek_video.json>`__ | xAPI `map <./xAPI_mapping.rst#edx-video-position-changed>`__ , `sample <../../event_routing_backends/processors/xapi/tests/fixtures/expected/seek_video.json>`__ | Caliper `map <./Caliper_mapping.rst#edx-video-position-changed>`__ , `sample <../../event_routing_backends/processors/caliper/tests/fixtures/expected/seek_video.json>`__
-* complete_video | edX `sample <../../event_routing_backends/processors/tests/fixtures/current/complete-video.json>`__ | xAPI `map <./xAPI_mapping.rst#complete_video>`__ , `sample <../../event_routing_backends/processors/xapi/tests/fixtures/expected/complete_video.json>`__ | Caliper `map <./Caliper_mapping.rst#complete-video>`__ , `sample <../../event_routing_backends/processors/caliper/tests/fixtures/expected/complete_video.json>`__
+* complete_video | edX `sample <../../event_routing_backends/processors/tests/fixtures/current/complete_video.json>`__ | xAPI `map <./xAPI_mapping.rst#complete_video>`__ , `sample <../../event_routing_backends/processors/xapi/tests/fixtures/expected/complete_video.json>`__ | Caliper `map <./Caliper_mapping.rst#complete_video>`__ , `sample <../../event_routing_backends/processors/caliper/tests/fixtures/expected/complete_video.json>`__
 
 Course navigation events
 ------------------------
 
-* `edx.ui.lms.sequence.outline.selected`_ | edX `sample <../../event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.sequence.outline.selected.json>`__ | xAPI `map <./xAPI_mapping.rst#edx-ui-lms-sequence-outline-selected>`__ , `sample <../../event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.sequence.outline.selected.json>`__ | Caliper `map <./Caliper_mapping.rst#edx-ui-lms-sequence-outline-selected>`__ , `sample <../../event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.sequence.outline.selected.json>`__
+* `edx.ui.lms.sequence.outline.selected`_ | edX `sample <../../event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.outline.selected.json>`__ | xAPI `map <./xAPI_mapping.rst#edx-ui-lms-sequence-outline-selected>`__ , `sample <../../event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.outline.selected.json>`__ | Caliper `map <./Caliper_mapping.rst#edx-ui-lms-sequence-outline-selected>`__ , `sample <../../event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.outline.selected.json>`__
 * `edx.ui.lms.sequence.next_selected`_  | edX `sample <../../event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.sequence.next_selected.json>`__ | xAPI `map <./xAPI_mapping.rst#edx-ui-lms-sequence-next-selected>`__ , `sample <../../event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.sequence.next_selected.json>`__  | Caliper `map <./Caliper_mapping.rst#edx-ui-lms-sequence-next-selected>`__ , `sample <../../event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.sequence.next_selected.json>`__
 * `edx.ui.lms.sequence.previous_selected`_ | edX `sample <../../event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.sequence.previous_selected.json>`__ | xAPI `map <./xAPI_mapping.rst#edx-ui-lms-sequence-previous-selected>`__ , `sample <../../event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.sequence.previous_selected.json>`__ | Caliper `map <./Caliper_mapping.rst#edx-ui-lms-sequence-previous-selected>`__ , `sample <../../event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.sequence.previous_selected.json>`__
 * `edx.ui.lms.sequence.tab_selected`_  | edX `sample <../../event_routing_backends/processors/tests/fixtures/current/edx.ui.lms.sequence.tab_selected.json>`__ | xAPI `map <./xAPI_mapping.rst#edx-ui-lms-sequence-tab-selected>`__ , `sample <../../event_routing_backends/processors/xapi/tests/fixtures/expected/edx.ui.lms.sequence.tab_selected.json>`__ | Caliper `map <./Caliper_mapping.rst#edx-ui-lms-sequence-tab-selected>`__ , `sample <../../event_routing_backends/processors/caliper/tests/fixtures/expected/edx.ui.lms.sequence.tab_selected.json>`__

diff --git a/docs/event-mapping/xAPI_mapping.rst b/docs/event-mapping/xAPI_mapping.rst
@@ -393,9 +393,8 @@ contextActivities [ parent [ objectType ] ]
 contextActivities [ parent [ id ] ]                                                <LMS_ROOT_URL>/course/<data [ course_id ]>
 contextActivities [ parent [ definition [ type ] ] ]                               http://adlnet.gov/expapi/activities/course
 contextActivities [ parent [ definition [ name ][ en-US ] ] ]                      <name of course-run>
-extensions [ http://id.tincanapi.com/extension/s
-tarting-point ]                   data [current_tab]
-extensions [ http://http://id.tincanapi.com/extension/ending-point ]               "next unit"
+extensions [ http://id.tincanapi.com/extension/starting-point ]                    data [current_tab]
+extensions [ http://id.tincanapi.com/extension/ending-point ]                      "next unit"
 ================================================================================== =============================================
 
 edx.ui.lms.sequence.previous_selected
@@ -421,9 +420,8 @@ contextActivities [ parent [ objectType ] ]
 contextActivities [ parent [ id ] ]                                                <LMS_ROOT_URL>/course/<data [ course_id ]>
 contextActivities [ parent [ definition [ type ] ] ]                               http://adlnet.gov/expapi/activities/course
 contextActivities [ parent [ definition [ name ][ en-US ] ] ]                      <name of course-run>
-extensions [ http://id.tincanapi.com/extension/s
-tarting-point ]                   data [current_tab]
-extensions [ http://http://id.tincanapi.com/extension/ending-point ]               "previous unit"
+extensions [ http://id.tincanapi.com/extension/starting-point ]                    data [current_tab]
+extensions [ http://id.tincanapi.com/extension/ending-point ]                      "previous unit"
 ================================================================================== =============================================
 
 edx.ui.lms.sequence.tab_selected
@@ -449,9 +447,8 @@ contextActivities [ parent [ objectType ] ]
 contextActivities [ parent [ id ] ]                                                <LMS_ROOT_URL>/course/<data [ course_id ]>
 contextActivities [ parent [ definition [ type ] ] ]                               http://adlnet.gov/expapi/activities/course
 contextActivities [ parent [ definition [ name ][ en-US ] ] ]                      <name of course-run>
-extensions [ http://id.tincanapi.com/extension/s
-tarting-point ]                   data [current_tab]
-extensions [ http://http://id.tincanapi.com/extension/ending-point ]               <data [ target_tab ]>
+extensions [ http://id.tincanapi.com/extension/starting-point ]                    data [current_tab]
+extensions [ http://id.tincanapi.com/extension/ending-point ]                      <data [ target_tab ]>
 ================================================================================== =============================================
 
 edx.ui.lms.link_clicked

diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -37,7 +37,7 @@ Event consumers may never want to lose certain events even after a brief failure
 Supported events and mapping of edx events onto xAPI and Caliper formats
 ------------------------------------------------------------------------
 
-List of supported edx events can be found in `Supported_events <./event-mapping/Supported_events.rst>`_ along with their mapping onto xAPI and Caliper format.
+List of supported edx events can be found in `Supported_events <https://github.com/openedx/event-routing-backends/blob/master/docs/event-mapping/Supported_events.rst>`_ along with their mapping onto xAPI and Caliper format.
 
 Version information of mapping
 ------------------------------

diff --git a/docs/howto/how_to_test.rst b/docs/howto/how_to_test.rst
@@ -40,7 +40,7 @@ Set the Django setting ``CALIPER_EVENTS_ENABLED`` or ``XAPI_EVENTS_ENABLED`` to
 Configure for testing
 ---------------------
 
-Follow instructions in `getting_started <docs/gettingstarted.rst>`_ doc. There is a chance some of this has already been done. Most of the code changes should just be copy and paste, but here are some suggested changes for debugging. It'll be easier to understand following instructions if you read `getting_started <docs/gettingstarted.rst>`_ doc first.
+Follow instructions in `getting started <docs/getting_started.rst>`_ doc. There is a chance some of this has already been done. Most of the code changes should just be copy and paste, but here are some suggested changes for debugging. It'll be easier to understand following instructions if you read `getting_started <docs/gettingstarted.rst>`_ doc first.
 
 Change router endpoint
 ~~~~~~~~~~~~~~~~~~~~~~

diff --git a/event_routing_backends/__init__.py b/event_routing_backends/__init__.py
@@ -2,6 +2,6 @@
 Various backends for receiving edX LMS events..
 """
 
-__version__ = '5.2.0'
+__version__ = '5.2.1'
 
 default_app_config = 'event_routing_backends.apps.EventRoutingBackendsConfig'  # pylint: disable=invalid-name