Sphinx with PlantUML and Japanese Font

「Sphinx は好きだ」
「Sphinx がお好き? けっこう。ではますます好きになりますよ。さぁさぁ、どうぞ。Sphinx のニューバージョンです。……便利でしょ? んああぁ、仰らないで。構文が複雑。でもMarkdownなんて見かけだけで、仕様は決まらないし、拡張しづらいし、互換性無いわ、ろくなことはない。プラグインもたっぷりありますよ。どんな要求でも大丈夫。どうぞ変換してみてください。……いいデザインでしょう? 余裕の絵だ、テンプレートが違いますよ。」

Sphinxいいですよね。しっかりしたドキュメントを書こうと思うと、Markdownは結構辛いですが、Sphinx ならいい感じに書けます。PlantUML や Graphviz と連携させて図形も reST の中で書くようにするとメンテナンス性もよくなり実に良い感じです。

…が、意外と変換環境を作るのが面倒なんですよね…。
一度作るとずっと使えますが、ふと、環境が変わると構築仕方がわからなくなるという…。

というわけで作ってみました。
Alpine版Python 3.6 ベースに Sphinx、Java8、Graphviz、PlantUML、VLGothicフォント をセットにした環境です。

GitHub: https://github.com/knaou/docker-sphinx-plantuml
DockerHub: https://hub.docker.com/r/knaou/sphinx-plantuml/

結構便利になりましたまる。

(ゴミデータは残さないようにう構築したつもりですが、まだ無駄などありましたらこっそり教えていただくか、PRくれると嬉しいです。)

Spread the love
  •  
  •  
  •  
  •  

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です