Description in Japanese

Sphinx-nekochanはSphinxドキュメントの中にネコチャン絵文字を挿入するための拡張機能です。

はじめかた

1. インストール

sphinx-nekochanはpipコマンドでインストールできます。

pip install sphinx-nekochan

2. 拡張の有効化

設定ファイルconf.pyの拡張のリストにsphinx_nekochanを追加します。

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

3. nekochanロール使用する

Sphinx中に以下のように記述すると、指定された文字列に対応したネコチャン絵文字が表示されます。

ネコチャン絵文字 {nekochan}`banzai` の世界へようこそ！！

* ネコチャン絵文字を楽しんでください {nekochan}`ok`
* 私は {nekochan}`beer` が好きです

ネコチャン絵文字 :nekochan:`banzai` の世界へようこそ！！

* ネコチャン絵文字を楽しんでください :nekochan:`ok`
* 私は :nekochan:`beer` が好きです

3. nekochanロール使用する

ネコチャン絵文字 の世界へようこそ！！

• ネコチャン絵文字を楽しんでください

• 私は が好きです

4. 絵文字の高さとaltをカスタマイズ

nekochanロールの名前の後ろにセミコロン(;)を付けると、高さとaltテキストをカスタマイズできます。

* 大きいくまネコチャン {nekochan}`kuma-nya;2em`
* 巨大な温泉ネコチャン {nekochan}`hot-spring;128px`
* 絵文字のaltテキストをカスタマイズ {nekochan}`gohan-taberu;3em;おにぎりを食べるネコチャン`

* 大きいくまネコチャン :nekochan:`kuma-nya;2em`
* 巨大な温泉ネコチャン :nekochan:`hot-spring;128px`
* 絵文字のaltテキストをカスタマイズ :nekochan:`gohan-taberu;3em;おにぎりを食べるネコチャン`

4. 絵文字の高さとaltをカスタマイズ

• 大きいくまネコチャン

• 巨大な温泉ネコチャン

• 絵文字のaltテキストをカスタマイズ

5. 絵文字を変換する

また、nekochanロールのaltテキストの後ろにセミコロン（;）を付けると、変換オプションを指定できます。

* スキップ {nekochan}`skip-nya;2em` を時計回りに90度回転 {nekochan}`skip-nya;2em;;rotate-90`
* ヨシ {nekochan}`yoshi;2em` の左右を反転 {nekochan}`yoshi;2em;;flip-horizontal`

* スキップ :nekochan:`skip-nya;2em` を時計回りに90度回転 :nekochan:`skip-nya;2em;;rotate-90`
* ヨシ :nekochan:`yoshi;2em` の左右を反転 :nekochan:`yoshi;2em;;flip-horizontal`

5. 絵文字を変換する

• スキップ を時計回りに90度回転

• ヨシ の左右を反転

ライセンス

• sphinx-nekochanのライセンスはMIT Licenseです

• ネコチャン絵文字の利用については、以下のガイドラインを参照してください

  • ネコチャン絵文字の利用に関するおやくそくなど｜しかまつ(ネコチャン絵文字職人)

ネコチャン絵文字について

この拡張機能で使用しているネコチャン絵文字は、しかまつさんが作成して配布しているものです。 拡張機能の作者であるtakanoryは、しかまつさんに許可をとり、絵文字の画像を拡張機能に同梱して使用させてもらっています（ありがとうございます）。

オリジナルのネコチャン絵文字は以下のnoteで配布されています。 ぜひSlackやDiscordで活用してください。

• SlackやDiscordで使えるネコチャン絵文字を配布しています♪｜しかまつ(ネコチャン絵文字職人)

また、LINEを使っている方はネコちゃん絵文字のスタンプがあります。 こちらもぜひご活用ください。

• しかまつのLINE スタンプ・絵文字一覧 | LINE STORE

この拡張機能を作成した背景

作者の@takanoryは会社のSlackに導入されたネコチャン絵文字を気に入っており、ヘビーに使いつつ自分が運営しているコミュニティのSlackにも導入して布教していました。

ある日しかまつさんのX(Twitter)で、プレゼン資料にネコチャン絵文字を使っている例が紹介されていました。

おおーー👏ネコチャンがあしらわれて楽しそうな資料ですﾆｬ https://t.co/m4edm3Fr4Z

— しかまつ👓ネコチャン絵文字配布中 (@shi_ka_ma_tsu) December 7, 2024

「なるほど、その手があったか！！」と思い、早速パク…リスペクトしようと考えました。 ただ、毎回発表スライドに画像をコピーして指定するのはダルいな…とも思いました。

私はスライドの作成にSphinxの拡張機能、sphinx-revealjsを使用しています（過去の発表スライド→slides.takanory.net）。 また、スライド中にFont Awesomeのアイコンを表示するために、Sphinx Designという拡張機能を使用しています。

同じように、シンプルな文字列（この場合はnekochanロールと絵文字の名前）でネコチャン絵文字をスライドに表示できるといいなと思い、初めてのSphinx拡張作成に挑戦しました。

sphinx-nekochanを使用して、日本中、世界中でネコチャン絵文字入りのドキュメント、スライドが作成されたらうれしいです！！

Enjoy!!

• sphinx-nekochan.readthedocs.io

• takanory/sphinx-nekochan

• pypi.org/project/sphinx-nekochan