Skip to content

Commit 71300c4

Browse files
sarinaregisb
authored andcommitted
docs: Update edx.rtd.io links to docs.openedx.org
1 parent a294834 commit 71300c4

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Supported formats:
66

77
- [Markdown](https://daringfireball.net/projects/markdown/): with [Pandoc-flavoured](https://garrettgman.github.io/rmarkdown/authoring_pandoc_markdown.html) header attributes.
88
- HTML 5
9-
- Open Learning XML ([OLX](https://edx.readthedocs.io/projects/edx-open-learning-xml/)) from [Open edX](https://openedx.org).
9+
- Open Learning XML ([OLX](https://docs.openedx.org/en/latest/educators/navigation/olx.html)) from [Open edX](https://openedx.org).
1010

1111
Check out the [course.md](https://github.com/overhangio/mu/blob/main/examples/course.md) file to see what an actual course in Markdown format looks like.
1212

mu/formats/olx/reader.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ def on_course(self, unit_xml: BeautifulSoup) -> t.Iterable[units.Unit]:
6363

6464
def on_problem(self, unit_xml: BeautifulSoup) -> t.Iterable[units.Unit]:
6565
"""
66-
https://edx.readthedocs.io/projects/edx-open-learning-xml/en/latest/problem-xml/checkbox.html
67-
https://edx.readthedocs.io/projects/edx-open-learning-xml/en/latest/problem-xml/text_input.html
66+
https://docs.openedx.org/en/latest/educators/references/course_development/exercise_tools/multi_select_xml.html
67+
https://docs.openedx.org/en/latest/educators/references/course_development/exercise_tools/text_input_xml.html
6868
"""
6969
# Parse question
7070
question_xml = unit_xml.find("label")
@@ -97,7 +97,7 @@ def on_problem(self, unit_xml: BeautifulSoup) -> t.Iterable[units.Unit]:
9797

9898
def on_html(self, unit_xml: BeautifulSoup) -> t.Iterable[units.Unit]:
9999
"""
100-
https://edx.readthedocs.io/projects/edx-open-learning-xml/en/latest/components/html-components.html
100+
https://docs.openedx.org/en/latest/educators/olx/components/html-components.html
101101
"""
102102
contents = "\n".join([str(c) for c in unit_xml.contents])
103103
yield units.RawHtml(
@@ -106,7 +106,7 @@ def on_html(self, unit_xml: BeautifulSoup) -> t.Iterable[units.Unit]:
106106

107107
def on_video(self, unit_xml: BeautifulSoup) -> t.Iterable[units.Unit]:
108108
"""
109-
https://edx.readthedocs.io/projects/edx-open-learning-xml/en/latest/components/video-components.html
109+
https://docs.openedx.org/en/latest/educators/olx/components/video-components.html
110110
"""
111111
sources: t.List[str] = []
112112
if youtube_id := unit_xml.attrs.get("youtube_id_1_0"):

mu/formats/olx/writer.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ def on_course(self, unit: units.Course) -> None:
5555

5656
def on_multiplechoicequestion(self, unit: units.MultipleChoiceQuestion) -> None:
5757
"""
58-
https://edx.readthedocs.io/projects/edx-open-learning-xml/en/latest/problem-xml/checkbox.html
58+
https://docs.openedx.org/en/latest/educators/references/course_development/exercise_tools/multi_select_xml.html
5959
6060
Note that we generate checkbox problems by default, and not multiple choice problem, which support only a single answer:
61-
https://edx.readthedocs.io/projects/edx-open-learning-xml/en/latest/problem-xml/multiple_choice.html#multiple-choice-problem-olx-reference
61+
https://docs.openedx.org/en/latest/educators/references/course_development/exercise_tools/single_select_xml.html
6262
"""
6363
problem_xml = self.process_unit(unit, "problem")
6464
response_xml = Tag(name="choiceresponse")
@@ -79,7 +79,7 @@ def on_multiplechoicequestion(self, unit: units.MultipleChoiceQuestion) -> None:
7979

8080
def on_freetextquestion(self, unit: units.MultipleChoiceQuestion) -> None:
8181
"""
82-
https://edx.readthedocs.io/projects/edx-open-learning-xml/en/latest/problem-xml/text_input.html
82+
https://docs.openedx.org/en/latest/educators/references/course_development/exercise_tools/text_input_xml.html
8383
"""
8484
problem_xml = self.process_unit(unit, "problem")
8585
response_xml = Tag(name="stringresponse")
@@ -98,7 +98,7 @@ def on_freetextquestion(self, unit: units.MultipleChoiceQuestion) -> None:
9898

9999
def on_rawhtml(self, unit: units.RawHtml) -> None:
100100
"""
101-
https://edx.readthedocs.io/projects/edx-open-learning-xml/en/latest/components/html-components.html
101+
https://docs.openedx.org/en/latest/educators/olx/components/html-components.html
102102
103103
Note that the spec is incorrect. We should use "filename" and not "file_name".
104104
"""
@@ -120,7 +120,7 @@ def on_rawhtml(self, unit: units.RawHtml) -> None:
120120

121121
def on_video(self, unit: units.Video) -> None:
122122
"""
123-
https://edx.readthedocs.io/projects/edx-open-learning-xml/en/latest/components/video-components.html
123+
https://docs.openedx.org/en/latest/educators/olx/components/video-components.html
124124
"""
125125
video_xml = self.process_unit(unit, "video")
126126
# We need to define an empty youtube url; otherwise the default video with Anant is picked up.

0 commit comments

Comments
 (0)