Put 🐱 Cat Emojis in your Documents!

Takanori Suzuki

PyCon US 2025 / 2025 May 18

Do you like cats? 🐱

IMO, Many programmers like Cats
🧑‍💻 👩‍💻 ❤️ 🐱

For example

[1]

Our Keynote Speaker is also like cats 😍

I like cats too 🐈

But I like Ferrets even more! 😍

About Cat Emojis 🐱

Cat Emojis for Slack & Discord

• Cat Emojis are Created and Distributed by Shikamatsu-san(@shi_ka_ma_tsu)

Cat Emojis for Slack & Discord

• I use it every day in company / community Slack

Cat Emojis for Slack & Discord

• You can download Cat Emojis!!

• note.com/shikamatsu/n/nd217dc0617db [2]

Cat Emojis in Documents 🐱 📄

Motivation

• Use Cat Emojis on My Slides

• Can do it by Copy & Paste Emoji image

Programmer is Lazy

Copy & Paste lots of Emojis is Boring

We have Python

Simplify the Boring Stuff with Python

sphinx-nekochan

(“Nekochan” is Cat in Japanese)

sphinx-nekochan

• Sphinx extension for adding Cat emoji to docs

• sphinx-nekochan.readthedocs.io

Sphinx 👁️‍🗨️

• www.sphinx-doc.org

• Easy to create intelligent and beautiful docs

• docs.python.org using Sphinx

Get Started

(env) % pip install sphinx-nekochan  # sphinx is also install
(env) % sphinx-quickstart  # generates Sphinx base files

• add extension in conf.py

extensions = [
    ...
    "sphinx_nekochan",
]

Get Started

• Use nekochan role in the document

I love {nekochan}`beer`

I love :nekochan:`beer`

• Build html documents

(env) % make html
(env) % open build/html/index.html

Get Started

• Cat Emoji displayed in the document!! 🎉

Find the Name of Cat Emoji 🔎

• List of Nekochan emoji

• List of Nekochan emoji without text

sphinx-nekochan on slides 💻

sphinx-revealjs

• sphinx-revealjs.readthedocs.io

• Sphinx extension to generate Reveal.js slides

sphinx-revealjs with sphinx-nekochan

• Same code will display Cat Emoji

I love {nekochan}`beer`

I love :nekochan:`beer`

I love

Customize emoji

Customize emoji Height [3]

* Big bear {nekochan}`bear;1.5em` default {nekochan}`bear`
* Huge hot-sprint nekochan {nekochan}`hot-spring;128px`

* Big bear :nekochan:`bear;1.5em` default :nekochan:`bear`
* Huge hot-sprint nekochan :nekochan:`hot-spring;128px`

• Big bear default

• Huge hot-sprint nekochan

Transform emoji [4]

* {nekochan}`skip` rotate {nekochan}`skip;;;rotate-90`
* {nekochan}`yoshi` flip horizontal
{nekochan}`yoshi;;;flip-horizontal`

* :nekochan:`skip` rotate :nekochan:`skip;;;rotate-90`
* :nekochan:`yoshi` flip horizontal
:nekochan:`yoshi;;;flip-horizontal`

• rotate

• flip horizontal

Enjoy sphinx-nekochan

• sphinx-nekochan.readthedocs.io

• takanory/sphinx-nekochan

  • Please GitHub star if you like it!

• pypi.org/project/sphinx-nekochan

Thank you

slides.takanory.net

sphinx-nekochan.readthedocs.io

takanory takanory takanory takanory