Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Markdown Support to docs.openedx.org #801

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add Markdown Support to docs.openedx.org #801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d41f42a
feat: Add support for markdown docs.
feanil Jan 22, 2025
2fb3c1c
chore: Run `make upgrade`
feanil Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions requirements/base.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ sphinxcontrib-images
sphinxcontrib-contentui
sphinxext-rediraffe
sphinx-tags
myst_parser
24 changes: 20 additions & 4 deletions requirements/base.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ colorama==0.4.6
# via sphinx-autobuild
docutils==0.21.2
# via
# myst-parser
# pydata-sphinx-theme
# sphinx
h11==0.14.0
Expand All @@ -39,9 +40,21 @@ idna==3.10
imagesize==1.4.1
# via sphinx
jinja2==3.1.5
# via sphinx
# via
# myst-parser
# sphinx
markdown-it-py==3.0.0
# via
# mdit-py-plugins
# myst-parser
markupsafe==3.0.2
# via jinja2
mdit-py-plugins==0.4.2
# via myst-parser
mdurl==0.1.2
# via markdown-it-py
myst-parser==4.0.0
# via -r requirements/base.in
packaging==24.2
# via sphinx
pydata-sphinx-theme==0.16.1
Expand All @@ -52,7 +65,9 @@ pygments==2.19.1
# pydata-sphinx-theme
# sphinx
pyyaml==6.0.2
# via sphinxcontrib-mermaid
# via
# myst-parser
# sphinxcontrib-mermaid
requests==2.32.3
# via
# sphinx
Expand All @@ -66,8 +81,9 @@ soupsieve==2.6
# via beautifulsoup4
sphinx==7.4.7
# via
# -c /home/runner/work/docs.openedx.org/docs.openedx.org/requirements/constraints.txt
# -c /home/feanil/src/openedx/docs.openedx.org/requirements/constraints.txt
# -r requirements/base.in
# myst-parser
# pydata-sphinx-theme
# sphinx-autobuild
# sphinx-book-theme
Expand Down Expand Up @@ -125,5 +141,5 @@ uvicorn==0.34.0
# via sphinx-autobuild
watchfiles==1.0.4
# via sphinx-autobuild
websockets==14.1
websockets==14.2
# via sphinx-autobuild
3 changes: 2 additions & 1 deletion source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@
"sphinxcontrib.mermaid",
"sphinx.ext.intersphinx",
"sphinxext.rediraffe",
"sphinx_tags"
"sphinx_tags",
"myst_parser",
]

# Extension Configuration
Expand Down