Sphinxでblockdiagを使って簡単にシーケンス図、ブロック図を含めたHTMLベースのドキュメントを生成する環境を整える - QiitaSphinxでblockdiagを使って簡単にシーケンス図、ブロック図を含めたHTMLベースのドキュメントを生成する環境を整えるSphinxblockdiag 概要 Sphinx は Python で作成されたドキュメント生成ツール。 コード内コメントや .rst でかかれたファイル等を元に HTML/epub/PDF などのフォーマットのドキュメントを生成出来る。 この記事では .rst を用いたドキュメント生成方法をまとめている。 セットアップ HTMLでの出力をするまでの設定。 まずPython環境を用意する。virtualenv等で環境を切っておくと良い。 pip で sphinx インストール後、新しいディレクトリ内で sphinx-quickstart を使ってプロジェクト作成を行う。
