sphinx-nekochan smile

A Sphinx extension for adding the Nekochan(cat) emoji to documents.

Hint

See Description in Japanese . 日本語の説明は Description in Japanese を参照してください。

Hint

Sample slide with Nekochan emoji (using sphinx-revealjs).

Get Started think-nya

1. Installation ok-nya

You can install sphinx-nekochan with pip:

pip install sphinx-nekochan

2. Enable extension good-nya

In your conf.py configuration file, add sphinx_nekochan to your extensions list:

extensions = [
    ...
    "sphinx_nekochan",
    ...
]

3. Use nekochan role clap-nya

When you use the nekochan roll, you will see any Nekochan emoji.

Welcome to Nekochan emoji {nekochan}`banzai` world!!

* Enjoy Nekochan emoji {nekochan}`ok`
* I love {nekochan}`beer`
Welcome to Nekochan emoji {nekochan}`banzai` world!!

* Enjoy Nekochan emoji {nekochan}`ok`
* I love {nekochan}`beer`

Welcome to Nekochan emoji banzai world!!

  • Enjoy Nekochan emoji ok

  • I love beer

4. Customize emoji height and alt text memo-nya

You can specify height and alt text with a semicolon(;) after the name of the nekochan role.

* Big bear nekochan {nekochan}`kuma-nya;2em`
* Huge hot-sprint nekochan {nekochan}`hot-spring;128px`
* Customize alt text for emoji {nekochan}`gohan-taberu;3em;Nekochan eating rice ball`
* Big bear nekochan :nekochan:`kuma-nya;2em`
* Huge hot-sprint nekochan :nekochan:`hot-spring;128px`
* Customize alt text for emoji :nekochan:`gohan-taberu;3em;Nekochan eating rice ball`
  • Big bear nekochan kuma-nya

  • Huge hot-sprint nekochan hot-spring

  • Customize alt text for emoji Nekochan eating rice ball

License ok2

Enjoy!! choo-choo-train

Table of Contents tunda