{"library":"sphinxemoji","title":"Sphinx Emoji Codes","type":"library","description":"Sphinx Emoji Codes (sphinxemoji) is a Sphinx extension that enables the use of emoji shortcodes (e.g., |:smile:|) directly within your Sphinx documentation. It is currently at version 0.3.2 and primarily releases updates to maintain compatibility with new Sphinx versions or to fix bugs.","language":"python","status":"active","last_verified":"Sun May 17","install":{"commands":["pip install sphinxemoji"],"cli":null},"imports":["extensions = ['sphinxemoji.sphinxemoji'] # In conf.py"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":"https://sphinxemojicodes.readthedocs.io","github":"https://github.com/sphinx-contrib/emojicodes","docs":"https://sphinxemojicodes.readthedocs.io","changelog":null,"pypi":"https://pypi.org/project/sphinxemoji/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"# conf.py\nextensions = [\n    'sphinxemoji.sphinxemoji',\n]\n\n# Your RST or MyST file (e.g., index.rst or index.md)\n# This text includes a smiley face |:smile:| and a snake too! |:snake:|\n# Don't you love it? |:heart_eyes:|\n\n# Optional: Set a consistent emoji style (e.g., Twemoji)\n# sphinxemoji_style = 'twemoji'","lang":"python","description":"To quickly enable `sphinxemoji`, add `'sphinxemoji.sphinxemoji'` to your `extensions` list in `conf.py`. Then, you can use emoji shortcodes wrapped in bars (e.g., `|:smile:|`) directly in your reStructuredText or MyST files. An optional `sphinxemoji_style` configuration can be added to `conf.py` to use a consistent emoji set like Twemoji.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-17","installed_version":"0.3.2","pypi_latest":"0.3.2","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":5.2,"avg_import_s":null,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"sphinxemoji","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"92.4M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"sphinxemoji","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.2,"import_time_s":null,"mem_mb":null,"disk_size":"93M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"sphinxemoji","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"101.6M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"sphinxemoji","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.1,"import_time_s":null,"mem_mb":null,"disk_size":"102M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"sphinxemoji","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"92.6M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"sphinxemoji","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5,"import_time_s":null,"mem_mb":null,"disk_size":"93M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"sphinxemoji","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"92.5M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"sphinxemoji","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":4.8,"import_time_s":null,"mem_mb":null,"disk_size":"93M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"sphinxemoji","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"91.8M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"sphinxemoji","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.9,"import_time_s":null,"mem_mb":null,"disk_size":"92M"}]}}