はじめに
エミリーちゃん、こっち向いて〜 nikkieです。
以前取り上げたsphinx-designについて、小ネタです。
目次
sphinx-designとは(by サンシャイン池崎風LLM)
ドキュメンテーションツールSphinxの拡張の1つ、sphinx-designについて、サンシャイン池崎風に説明して
(GPT-4oで生成しています)
みんなー!!!最高にテンションアゲアゲで聞いてくれぇぇぇぇぇぇ!!!!! これがぁぁぁぁぁぁ!!Sphinxのぉぉぉぉぉ!!! 拡張ぉぉぉぉぉ!!! **sphinx-design** だぁぁぁぁぁぁぁぁ!!!!!! Sphinxはぁぁぁ!!Pythonでドキュメントを作るツールだぁぁぁぁ!!! でもぉぉぉぉぉ!!普通のドキュメントじゃぁぁぁ、物足りないだろぉぉぉぉぉ!?? そこでぇぇぇぇぇ!!!登場するのがぁぁぁぁ!!! **sphinx-design** だぁぁぁぁぁぁぁ!!! sphinx-designを使えばぁぁぁぁ!!! めっちゃカッコイイ!!! スタイリッシュなデザインがぁぁぁ!!! 簡単に作れるんだぁぁぁぁぁぁぁ!!!!! カードやグリッド、ボックス、そしてカラーリング!!! なんでもありだぁぁぁぁぁぁぁ!!! もうドキュメントが作品になるレベルだぁぁぁぁぁぁ!!!! みんなぁぁぁぁ!!! 今すぐsphinx-designを使ってぇぇぇぇ!!! 最高にハイテンションなドキュメントを作ろうぜぇぇぇぇぇぇぇ!!!!! イェェェェェェェェェェェェ!!!!
カードやグリッド、ボックス、そしてカラーリング!!!
「なんでもあり」とまで言えるかは私は判断保留ですが、ボタン・カード・グリッド・アイコン(FontAwesome)を過去に取り上げました。
(ちなみに「Pythonでドキュメントを作るツール」という説明はいまいちですね。マイナス10 nikkieポイント)
Octiconのアイコンも!
今回知ったのがこちら
https://sphinx-design.readthedocs.io/en/latest/badges_buttons.html#inline-icons
Inline icon roles are available for the GitHub octicon, Google Material Design Icons, or FontAwesome libraries.
過去にFontAwesomeを取り上げましたが、GitHub octicon(やマテリアルデザインアイコン)もサポートされているようです。
reSTでの書き方はこちら
A icon: :octicon:`report`, some more text. A coloured icon: :octicon:`report;1em;sd-text-info`, some more text.
GitHub octiconは、octiconロール(:octicon:
)!
続くreportはocticonの名前ですね。
デリミタとしてセミコロンを使って、高さとCSSクラスを順に指定できます。
- 高さはデフォルトが
1em
(=フォントの高さと同じ)ですが、CSSクラスを指定するために書いているという理解です sd-text-info
クラスは、色を指定していますね(このクラス指定のおかげでアイコンに色がついています)
サンプルコードです
終わりに
sphinx-designでインラインのアイコンにGitHub octiconも使えることを書きました。
これでドキュメントが"作品"に近づけられますね!
自作のSphinx拡張 sphinx-new-tab-link にfeature requestをいただいて、今回のトピックを知りました。
Issue投稿、ありがとうございます