sphinx

sphinxで雑にコード例と実行結果を表示したい場合

sphinxで雑にコード例と実行結果を表示したい場合がある。コード例はliteralincludeを使うと便利。一方実行結果をどうするのかというのが悩みどころ。 現状はMakefileで出力結果を生成してliteralincludeで埋め込んでいる。 こういう感じ .. literalinclude:…

sphinxのliteralincludeが絶対パスを表示するのが嫌だった

sphinxのliteralincludeが絶対パスを表示するのが嫌だった。 以下の様なmonkey patchをあてるextensionを作ってあげると無理矢理変更できる(わるい) def setup(app): # monkey patch import os.path from difflib import unified_diff from sphinx.directive…

そろそろドキュメントを書き始めることにした

github.com そろそろドキュメントを書き始めることにした。ただまだまだ個人用のつもりなのでまともな文章は書かない。 どうしてドキュメントがほしくなったか? どうしてドキュメントが欲しくなったかというと、このはてなブログの記事だけでは断片的な情報…