Skip to content

Add emoji support to docs using sphinxemoji ✨#1006

Closed
skylentshore wants to merge 25 commits into
openedx:mainfrom
skylentshore:add-emoji-support
Closed

Add emoji support to docs using sphinxemoji ✨#1006
skylentshore wants to merge 25 commits into
openedx:mainfrom
skylentshore:add-emoji-support

Conversation

@skylentshore
Copy link
Copy Markdown
Contributor

This PR adds emoji support to the Open edX documentation via sphinxemoji, enabling use of emojis in .rst files with the |:emoji:| syntax.

The conf.py is updated to include the extension.

Style is set to 'twemoji' for consistency.

A sample line using emojis has been added to the top of index.rst to demonstrate functionality. Happy to remove or relocate that as needed.

All supporting extensions and themes were confirmed working locally.

@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Apr 14, 2025

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 14, 2025
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Apr 14, 2025
@skylentshore
Copy link
Copy Markdown
Contributor Author

Hi! The Read the Docs build failed because the new extension (sphinxemoji) isn’t included in the RTD install environment yet. Everything works locally and builds cleanly — happy to help with the RTD config if needed!

CLA has been signed ✅
cc @openedx/docs-openedx-org-maintainers

@mphilbrick211
Copy link
Copy Markdown

Thanks for this contribution, @skylentshore!

Did you receive a fully executed version of the CLA form? Or was it submitted today? The turnaround is about 24 hours. If you haven't heard within a few days, please let me know!

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Needs Tests Run or CLA Signed in Contributions Apr 14, 2025
@sarina
Copy link
Copy Markdown
Contributor

sarina commented Apr 14, 2025

Hi @skylentshore - thanks for the contribution!

You shouldn't need to check in the build files. I would expect the diff to look similar to this one, where we added the 404 extension: #850

@sarina sarina moved this from Needs Tests Run or CLA Signed to Waiting on Author in Contributions Apr 15, 2025
@sarina
Copy link
Copy Markdown
Contributor

sarina commented Apr 16, 2025

Hi @skylentshore - I'd recommend closing this PR and starting a new one. Adding support should be very simple:

  • Add the new package to base.in
  • Add to conf.py
  • Run make upgrade

Then, try adding an emoji to a page in a separate commit, so we can test that it works.

@github-project-automation github-project-automation Bot moved this from Waiting on Author to Done in Contributions Apr 16, 2025
@skylentshore skylentshore deleted the add-emoji-support branch April 16, 2025 13:45
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.

4 participants