https://github.com/sphinx-contrib/emojicodes

An extension to use emoji codes in your Sphinx documentation! 😍
https://github.com/sphinx-contrib/emojicodes

documentation emoji hacktoberfest python sphinx sphinx-extension sphinxcontrib twemoji

Last synced: 3 days ago
JSON representation

An extension to use emoji codes in your Sphinx documentation! 😍

• Host: GitHub
• URL: https://github.com/sphinx-contrib/emojicodes
• Owner: sphinx-contrib
• License: bsd-3-clause
• Created: 2019-02-14T20:37:58.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-18T18:06:13.000Z (12 months ago)
• Last Synced: 2024-12-30T00:12:19.790Z (10 days ago)
• Topics: documentation, emoji, hacktoberfest, python, sphinx, sphinx-extension, sphinxcontrib, twemoji
• Language: Python
• Homepage: https://sphinxemojicodes.readthedocs.io/
• Size: 117 KB
• Stars: 52
• Watchers: 8
• Forks: 15
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Sphinx Emoji Codes

==================

An extension to use emoji codes in your Sphinx documentation!

.. code::

   pip install sphinxemoji

Usage

-----

Enable the Sphinx extension(s) in your ``conf.py`` file:

.. code:: python

   extensions = [

       '...',

       'sphinxemoji.sphinxemoji',

   ]

Then you can use emoji code replacements by writing them between bars:

.. code:: rst

   This text includes a smiley face |:smile:| and a snake too! |:snake:|

   Don't you love it? |:heart_eyes:|

You can find the list of all supported emoji codes `in the project's documentation page

`_.

Configuration

-------------

If you want a consistent emoji style instead of using the browser's default,

you can set it in your ``conf.py`` file:

.. code:: python

   sphinxemoji_style = 'twemoji'

By default Twemoji is obtained from a CDN. If you want to specify your own

source location (be it local or from another CDN), you can do so via the ``conf.py`` file:

.. code:: python

   sphinxemoji_source = 'https://unpkg.com/twemoji@latest/dist/twemoji.min.js'

   # or: sphinxemoji_source = 'my-local-twemoji.min.js'

Build

-----

You can build this package by running this command from the root directory:

.. code::

   python -m build

Notes

-----

Emoji substitutions are processed after default substitutions like

``|release|``, ``|version|`` and ``|today|``, but before any other

substitutions in source files (i.e. emoji substitutions can be overriden).