Emoji support: Adds emoji support to the documentation by including the sphinxemoji extension.#1007
Conversation
|
Thanks for the pull request, @skylentshore! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
|
Added Emojis. All checks passing now! |
| 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 |
There was a problem hiding this comment.
This line needs to not change
There was a problem hiding this comment.
Thanks @sarina! I've updated requirements/base.txt to reflect Python 3.12 and restored the original constraint path. The build now passes all checks.
| @@ -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 | |||
There was a problem hiding this comment.
Your venv should have Python 3.12 installed :)
|
Thanks @skylentshore ! Could we add another commit to add an emoji to a page, to show it works? How about a final sentence on https://docs.openedx.org/en/latest/educators/quickstarts/build_a_course.html "Congrats - you have built your first course 🎉 " |
|
@sarina Done! I’ve added the emoji at the end of the “Build a Course” quickstart as requested: “Congrats – you have built your first course 🎉” Also verified it builds locally with the emoji extension working as expected. Let me know if there’s anything else you'd like me to tweak! |
|
https://docsopenedxorg--1007.org.readthedocs.build/en/1007/educators/quickstarts/build_a_course.html Looks great! Can I bug you to put that line above the See Also table? Then I think we're good to go! |
|
@sarina moved the emoji line above the chart at the end! |
|
Thanks! I'll merge once the build passes. We really appreciate your contribution! I maintain this repo, and another good first issue is #591, I also maintain the OEP repo and we have some more-involved but still straightforward issues here: https://github.com/openedx/open-edx-proposals/issues (if you're looking to contribute more!) |

sphinxemoji==0.3.1torequirements/base.txtsphinxemoji.sphinxemojiinsource/conf.py