Skip to content

Emoji support: Adds emoji support to the documentation by including the sphinxemoji extension.#1007

Merged
sarina merged 9 commits into
openedx:mainfrom
skylentshore:emoji-support
Apr 16, 2025
Merged

Emoji support: Adds emoji support to the documentation by including the sphinxemoji extension.#1007
sarina merged 9 commits into
openedx:mainfrom
skylentshore:emoji-support

Conversation

@skylentshore
Copy link
Copy Markdown
Contributor

  • Added sphinxemoji==0.3.1 to requirements/base.txt
  • Registered sphinxemoji.sphinxemoji in source/conf.py

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 16, 2025
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @skylentshore!

This repository is currently maintained by @openedx/docs-openedx-org-maintainers.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@skylentshore
Copy link
Copy Markdown
Contributor Author

Added Emojis. All checks passing now!
@openedx/docs-openedx-org-maintainers

Comment thread requirements/base.txt Outdated
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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line needs to not change

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread requirements/base.txt Outdated
@@ -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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your venv should have Python 3.12 installed :)

@sarina
Copy link
Copy Markdown
Contributor

sarina commented Apr 16, 2025

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 🎉 "

@skylentshore
Copy link
Copy Markdown
Contributor Author

@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!

@sarina
Copy link
Copy Markdown
Contributor

sarina commented Apr 16, 2025

https://docsopenedxorg--1007.org.readthedocs.build/en/1007/educators/quickstarts/build_a_course.html

image

Looks great! Can I bug you to put that line above the See Also table? Then I think we're good to go!

@sarina sarina moved this from Needs Triage to In Eng Review in Contributions Apr 16, 2025
@sarina sarina linked an issue Apr 16, 2025 that may be closed by this pull request
@skylentshore
Copy link
Copy Markdown
Contributor Author

@sarina moved the emoji line above the chart at the end!

@sarina
Copy link
Copy Markdown
Contributor

sarina commented Apr 16, 2025

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!)

@sarina sarina merged commit b7ef525 into openedx:main Apr 16, 2025
2 checks passed
@github-project-automation github-project-automation Bot moved this from In Eng Review to Done in Contributions Apr 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Add Emoji Support to docs.openedx.org

3 participants