最近Sphinxでよくドキュメントを書くのでメモ。やっぱりある程度巨大なソフトウェアのドキュメントを書く時はWikiじゃなくてSphinxの方が良い気がする。 リンク 他のファイルのセクションにリンクを貼るときには そのセクションの前で .. _label: のようにラベル定義 :ref:`label`でリンクを張る という感じ。ラベルの名前はドキュメント全体でユニークにする必要がある。 参考 ソースコードのinclude literalincludeを使う。外部のソースファイルをincludeする時に使った。 .. literalinclude:: ../../src/main/java/net/lampetty/commons/MarkingStopwatch.java :language: java :linenos: 参考 テーブル 通常のテーブルの書き方は非常に面倒なので csv