From 4abbc12a7ab4b2beff5cae7005c9368f3901cea0 Mon Sep 17 00:00:00 2001 From: Skylent Shore Date: Wed, 16 Apr 2025 08:43:19 -0500 Subject: [PATCH 1/9] Add sphinxemoji and sphinx-notfound-page manually --- requirements/base.in | 3 ++- requirements/base.txt | 23 ++++++++++++++++++----- 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/requirements/base.in b/requirements/base.in index e4150162e..a19570eea 100644 --- a/requirements/base.in +++ b/requirements/base.in @@ -12,4 +12,5 @@ sphinxcontrib-images sphinxcontrib-contentui sphinxext-rediraffe sphinx-tags -sphinx-notfound-page \ No newline at end of file +sphinx-notfound-page +sphinxemoji diff --git a/requirements/base.txt b/requirements/base.txt index 8927023fa..be3c4879d 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile with Python 3.12 +# This file is autogenerated by pip-compile with Python 3.9 # by the following command: # # make upgrade @@ -16,7 +16,7 @@ babel==2.17.0 # via # pydata-sphinx-theme # sphinx -beautifulsoup4==4.13.3 +beautifulsoup4==4.13.4 # via pydata-sphinx-theme certifi==2025.1.31 # via requests @@ -30,6 +30,8 @@ docutils==0.21.2 # via # pydata-sphinx-theme # sphinx +exceptiongroup==1.2.2 + # via anyio h11==0.14.0 # via uvicorn idna==3.10 @@ -38,6 +40,8 @@ idna==3.10 # requests imagesize==1.4.1 # via sphinx +importlib-metadata==8.6.1 + # via sphinx jinja2==3.1.6 # via sphinx markupsafe==3.0.2 @@ -68,7 +72,7 @@ soupsieve==2.6 # via beautifulsoup4 sphinx==7.4.7 # via - # -c /home/runner/work/docs.openedx.org/docs.openedx.org/requirements/constraints.txt + # -c /Users/skylentshore/docs.openedx.org/requirements/constraints.txt # -r requirements/base.in # pydata-sphinx-theme # sphinx-autobuild @@ -81,6 +85,7 @@ sphinx==7.4.7 # sphinxcontrib-images # sphinxcontrib-mermaid # sphinxcontrib-youtube + # sphinxemoji # sphinxext-rediraffe sphinx-autobuild==2024.10.3 # via -r requirements/base.in @@ -114,22 +119,30 @@ sphinxcontrib-serializinghtml==2.0.0 # via sphinx sphinxcontrib-youtube==1.4.1 # via -r requirements/base.in +sphinxemoji==0.3.1 + # via -r requirements/base.in sphinxext-rediraffe==0.2.7 # via -r requirements/base.in -starlette==0.46.1 +starlette==0.46.2 # via sphinx-autobuild +tomli==2.2.1 + # via sphinx typing-extensions==4.13.2 # via # anyio # beautifulsoup4 # pydata-sphinx-theme + # starlette + # uvicorn urllib3==2.2.3 # via # -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt # requests -uvicorn==0.34.0 +uvicorn==0.34.1 # via sphinx-autobuild watchfiles==1.0.5 # via sphinx-autobuild websockets==15.0.1 # via sphinx-autobuild +zipp==3.21.0 + # via importlib-metadata From 00bc8fb05de420c7bf9d171d1dc6278c5d47840c Mon Sep 17 00:00:00 2001 From: Skylent Shore Date: Wed, 16 Apr 2025 08:47:43 -0500 Subject: [PATCH 2/9] Enable sphinxemoji extension in conf.py --- source/conf.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/conf.py b/source/conf.py index 05dff964e..35abd9df6 100644 --- a/source/conf.py +++ b/source/conf.py @@ -49,7 +49,10 @@ "sphinx.ext.intersphinx", "sphinxext.rediraffe", "notfound.extension", - "sphinx_tags" + "sphinx_tags", + "sphinxemoji.sphinxemoji", +] + ] # Extension Configuration From 4a3bb006e0f954a57c9a50c1fa8e58a315f6cc86 Mon Sep 17 00:00:00 2001 From: Skylent Shore Date: Wed, 16 Apr 2025 08:53:40 -0500 Subject: [PATCH 3/9] Add emoji support via sphinxemoji --- requirements/pip-tools.txt | 10 +++++++++- requirements/pip.txt | 2 +- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/requirements/pip-tools.txt b/requirements/pip-tools.txt index 31d211cc7..dd7606e6c 100644 --- a/requirements/pip-tools.txt +++ b/requirements/pip-tools.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile with Python 3.12 +# This file is autogenerated by pip-compile with Python 3.9 # by the following command: # # make upgrade @@ -8,6 +8,8 @@ build==1.2.2.post1 # via pip-tools click==8.1.8 # via pip-tools +importlib-metadata==8.6.1 + # via build packaging==24.2 # via build pip-tools==7.4.1 @@ -16,8 +18,14 @@ pyproject-hooks==1.2.0 # via # build # pip-tools +tomli==2.2.1 + # via + # build + # pip-tools wheel==0.45.1 # via pip-tools +zipp==3.21.0 + # via importlib-metadata # The following packages are considered to be unsafe in a requirements file: # pip diff --git a/requirements/pip.txt b/requirements/pip.txt index bf4c9a2f5..1419e8752 100644 --- a/requirements/pip.txt +++ b/requirements/pip.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile with Python 3.12 +# This file is autogenerated by pip-compile with Python 3.9 # by the following command: # # make upgrade From 20d26a7b58b27d08796f98b22e93a31aa3b5ad3c Mon Sep 17 00:00:00 2001 From: Skylent Shore Date: Wed, 16 Apr 2025 09:01:38 -0500 Subject: [PATCH 4/9] Add sphinxemoji support and fix RTD build config --- source/conf.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/conf.py b/source/conf.py index 35abd9df6..b2dff7aec 100644 --- a/source/conf.py +++ b/source/conf.py @@ -53,8 +53,6 @@ "sphinxemoji.sphinxemoji", ] -] - # Extension Configuration graphviz_output_format = "svg" From 2509b8a5b362f43589cd2d265974de27cdb70195 Mon Sep 17 00:00:00 2001 From: Skylent Shore Date: Wed, 16 Apr 2025 10:53:39 -0500 Subject: [PATCH 5/9] Regenerate base.txt with Python 3.12 and fix constraint comment --- requirements/base.txt | 23 +++++------------------ 1 file changed, 5 insertions(+), 18 deletions(-) diff --git a/requirements/base.txt b/requirements/base.txt index be3c4879d..8927023fa 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile with Python 3.9 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade @@ -16,7 +16,7 @@ babel==2.17.0 # via # pydata-sphinx-theme # sphinx -beautifulsoup4==4.13.4 +beautifulsoup4==4.13.3 # via pydata-sphinx-theme certifi==2025.1.31 # via requests @@ -30,8 +30,6 @@ docutils==0.21.2 # via # pydata-sphinx-theme # sphinx -exceptiongroup==1.2.2 - # via anyio h11==0.14.0 # via uvicorn idna==3.10 @@ -40,8 +38,6 @@ idna==3.10 # requests imagesize==1.4.1 # via sphinx -importlib-metadata==8.6.1 - # via sphinx jinja2==3.1.6 # via sphinx markupsafe==3.0.2 @@ -72,7 +68,7 @@ soupsieve==2.6 # via beautifulsoup4 sphinx==7.4.7 # via - # -c /Users/skylentshore/docs.openedx.org/requirements/constraints.txt + # -c /home/runner/work/docs.openedx.org/docs.openedx.org/requirements/constraints.txt # -r requirements/base.in # pydata-sphinx-theme # sphinx-autobuild @@ -85,7 +81,6 @@ sphinx==7.4.7 # sphinxcontrib-images # sphinxcontrib-mermaid # sphinxcontrib-youtube - # sphinxemoji # sphinxext-rediraffe sphinx-autobuild==2024.10.3 # via -r requirements/base.in @@ -119,30 +114,22 @@ sphinxcontrib-serializinghtml==2.0.0 # via sphinx sphinxcontrib-youtube==1.4.1 # via -r requirements/base.in -sphinxemoji==0.3.1 - # via -r requirements/base.in sphinxext-rediraffe==0.2.7 # via -r requirements/base.in -starlette==0.46.2 +starlette==0.46.1 # via sphinx-autobuild -tomli==2.2.1 - # via sphinx typing-extensions==4.13.2 # via # anyio # beautifulsoup4 # pydata-sphinx-theme - # starlette - # uvicorn urllib3==2.2.3 # via # -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt # requests -uvicorn==0.34.1 +uvicorn==0.34.0 # via sphinx-autobuild watchfiles==1.0.5 # via sphinx-autobuild websockets==15.0.1 # via sphinx-autobuild -zipp==3.21.0 - # via importlib-metadata From a7da9716ef3d59c029c51c88bc4fdf698400cccb Mon Sep 17 00:00:00 2001 From: Skylent Shore Date: Wed, 16 Apr 2025 11:09:29 -0500 Subject: [PATCH 6/9] Add sphinxemoji to requirements --- requirements/base.txt | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/requirements/base.txt b/requirements/base.txt index 8927023fa..be3c4879d 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile with Python 3.12 +# This file is autogenerated by pip-compile with Python 3.9 # by the following command: # # make upgrade @@ -16,7 +16,7 @@ babel==2.17.0 # via # pydata-sphinx-theme # sphinx -beautifulsoup4==4.13.3 +beautifulsoup4==4.13.4 # via pydata-sphinx-theme certifi==2025.1.31 # via requests @@ -30,6 +30,8 @@ docutils==0.21.2 # via # pydata-sphinx-theme # sphinx +exceptiongroup==1.2.2 + # via anyio h11==0.14.0 # via uvicorn idna==3.10 @@ -38,6 +40,8 @@ idna==3.10 # requests imagesize==1.4.1 # via sphinx +importlib-metadata==8.6.1 + # via sphinx jinja2==3.1.6 # via sphinx markupsafe==3.0.2 @@ -68,7 +72,7 @@ soupsieve==2.6 # via beautifulsoup4 sphinx==7.4.7 # via - # -c /home/runner/work/docs.openedx.org/docs.openedx.org/requirements/constraints.txt + # -c /Users/skylentshore/docs.openedx.org/requirements/constraints.txt # -r requirements/base.in # pydata-sphinx-theme # sphinx-autobuild @@ -81,6 +85,7 @@ sphinx==7.4.7 # sphinxcontrib-images # sphinxcontrib-mermaid # sphinxcontrib-youtube + # sphinxemoji # sphinxext-rediraffe sphinx-autobuild==2024.10.3 # via -r requirements/base.in @@ -114,22 +119,30 @@ sphinxcontrib-serializinghtml==2.0.0 # via sphinx sphinxcontrib-youtube==1.4.1 # via -r requirements/base.in +sphinxemoji==0.3.1 + # via -r requirements/base.in sphinxext-rediraffe==0.2.7 # via -r requirements/base.in -starlette==0.46.1 +starlette==0.46.2 # via sphinx-autobuild +tomli==2.2.1 + # via sphinx typing-extensions==4.13.2 # via # anyio # beautifulsoup4 # pydata-sphinx-theme + # starlette + # uvicorn urllib3==2.2.3 # via # -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt # requests -uvicorn==0.34.0 +uvicorn==0.34.1 # via sphinx-autobuild watchfiles==1.0.5 # via sphinx-autobuild websockets==15.0.1 # via sphinx-autobuild +zipp==3.21.0 + # via importlib-metadata From d75ad5d0eec016755342950f6dd63668b6015c80 Mon Sep 17 00:00:00 2001 From: Skylent Shore Date: Wed, 16 Apr 2025 11:28:44 -0500 Subject: [PATCH 7/9] Recompile base.txt with Python 3.12 and correct constraint path --- requirements/base.txt | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/requirements/base.txt b/requirements/base.txt index be3c4879d..8d5d81078 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile with Python 3.9 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade @@ -30,8 +30,6 @@ docutils==0.21.2 # via # pydata-sphinx-theme # sphinx -exceptiongroup==1.2.2 - # via anyio h11==0.14.0 # via uvicorn idna==3.10 @@ -40,8 +38,6 @@ idna==3.10 # requests imagesize==1.4.1 # via sphinx -importlib-metadata==8.6.1 - # via sphinx jinja2==3.1.6 # via sphinx markupsafe==3.0.2 @@ -72,7 +68,7 @@ soupsieve==2.6 # via beautifulsoup4 sphinx==7.4.7 # via - # -c /Users/skylentshore/docs.openedx.org/requirements/constraints.txt + # -c /home/runner/work/docs.openedx.org/docs.openedx.org/requirements/constraints.txt # -r requirements/base.in # pydata-sphinx-theme # sphinx-autobuild @@ -125,15 +121,11 @@ sphinxext-rediraffe==0.2.7 # via -r requirements/base.in starlette==0.46.2 # via sphinx-autobuild -tomli==2.2.1 - # via sphinx typing-extensions==4.13.2 # via # anyio # beautifulsoup4 # pydata-sphinx-theme - # starlette - # uvicorn urllib3==2.2.3 # via # -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt @@ -144,5 +136,3 @@ watchfiles==1.0.5 # via sphinx-autobuild websockets==15.0.1 # via sphinx-autobuild -zipp==3.21.0 - # via importlib-metadata From dc3ac9f43363be5d4870e089e5a8214b2c5bf039 Mon Sep 17 00:00:00 2001 From: Skylent Shore Date: Wed, 16 Apr 2025 12:57:12 -0500 Subject: [PATCH 8/9] Add emoji celebration line to end of Build a Course quickstart --- source/educators/quickstarts/build_a_course.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/educators/quickstarts/build_a_course.rst b/source/educators/quickstarts/build_a_course.rst index c399b07cf..fce28f7a3 100644 --- a/source/educators/quickstarts/build_a_course.rst +++ b/source/educators/quickstarts/build_a_course.rst @@ -127,3 +127,5 @@ Follow the steps below to build your first course. By the end, you will have a f +--------------+-------------------------------+----------------+--------------------------------+ | | | | | +--------------+-------------------------------+----------------+--------------------------------+ + +Congrats – you have built your first course 🎉 \ No newline at end of file From 349d834a8dbf10fabdf68d8219e83446b9811a8e Mon Sep 17 00:00:00 2001 From: Skylent Shore Date: Wed, 16 Apr 2025 13:15:23 -0500 Subject: [PATCH 9/9] =?UTF-8?q?Add=20celebratory=20message=20to=20course?= =?UTF-8?q?=20quickstart=20=F0=9F=8E=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- source/educators/quickstarts/build_a_course.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/source/educators/quickstarts/build_a_course.rst b/source/educators/quickstarts/build_a_course.rst index fce28f7a3..e9a0152d9 100644 --- a/source/educators/quickstarts/build_a_course.rst +++ b/source/educators/quickstarts/build_a_course.rst @@ -118,7 +118,7 @@ Follow the steps below to build your first course. By the end, you will have a f :ref:`View As Learner` (how-to) - +Congrats – you have built your first course 🎉 **Maintenance chart** @@ -127,5 +127,3 @@ Follow the steps below to build your first course. By the end, you will have a f +--------------+-------------------------------+----------------+--------------------------------+ | | | | | +--------------+-------------------------------+----------------+--------------------------------+ - -Congrats – you have built your first course 🎉 \ No newline at end of file