search

sphinx-contrib / emojicodes

An extension to use emoji codes in your Sphinx documentation! 😍
https://sphinxemojicodes.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
48 stars 15 forks source link

Guidance to add it to readthedocs #43

Closed gwilku closed 1 year ago

gwilku commented 1 year ago

Hi,

Is there a chance for a step-by-step manual on how to add this to one's project in readthedocs? I followed the instructions, I can see RTD installs sphinxemoji, I have it in extensions, build goes through successfully, however no replacement happens and I see |:rawemojitexthere:| instead of the images/glyphs. What am I missing?

Peque commented 1 year ago

@gwilku Are you using .rst or .md files in your documentation?

If you are using Markdown, I think this is relevant: https://github.com/sphinx-contrib/emojicodes/issues/40

gwilku commented 1 year ago

Hi, I'm using .rst

Peque commented 1 year ago

@gwilku Do you have a minimal reproducible example to share?

gwilku commented 1 year ago

@Peque , not anymore, as it started working.

However I would advise to monitor the situation, because the emojis didn't work when RTD rolled out a hard-block on crashed PDF generation. Now RTD have rolled that change back, and - even though I haven't changed a single thing in my config - the emojis now get replaced as expected.

I only had to add sphinxemoji to requirements.txt and extensions =[] list.