Sphinx の拡張機能をドキュメント内に同梱してみるテスト

  1. ドキュメント内に拡張機能(独自のdirective)を同梱することで配布が容易
    • あれこれ pip install hogehoge しなくて済む
    • 拡張機能のバージョンアップも安心
  2. bizstyle テーマも同梱。見やすい。カスタマイズもできる。

Contents:

UML サンプル (plantuml)

sphinxcontrib.plantuml を用いたサンプルです。

シーケンス図

ユースケース

画像集 (pptshape)

pptshape を用いたサンプル。

爆発1

_images/bomb-black.png

爆発2

_images/bomb.png

PowerPoint上で Bingった Sphinxその1

_images/sphinx-statue.png

PowerPoint上で Bingった Sphinxその2

_images/sphinx-real.png

表(テーブル)

list-table

replace を使ってテーブルに画像をはりつける

sphinx1 sphinx2
real statue

検索とテーブル