Standing on the Shoulder of Linus

Home / 2010 / 12月 / 12 / Sphinxでドキュメント生成

Sphinxでドキュメント生成

sphinxを用いてドキュメント生成してみました。OSC東京等で情報は得ていたのですが、ようやく使ってみる機会がありました。

システムとしては、wiki に近いと思います。特定の記号でセクションや箇条書きを指定します。インデントも活用するのは、python らしい設計かもしれません。

私がいいな、と思った特徴は、ソース(HTML 等に変換する前のテキスト)の可読性もかなりの程度確保されていることです。wiki はソースでもまだ読めますが、LaTeX は(LaTeX に習熟していない限り)ソースは読めたもんじゃありません。プログラムソースをそのまま書いて、整形してくれるのも嬉しいですね(例えば、HTML に HTML コードを書くときは、>を>に書き換えるようなことが必要ですが、sphinxでは不要)。この点で、プログラムコードと普通の文が混じるような解説テキストを書くのに非常に便利なツールだと思いました。

楽天で検索
【楽天ブックスならいつでも送料無料】エキスパートPythonプログラミング [ タレク・ジアデ ]
3888円
タレク・ジアデ 稲田直哉 アスキー・メディアワークス KADOKAWA発行年月:2010年05月 ページ数:415p サイズ:単行本 ISBN:97840486
楽天ブックス
Supported by 楽天ウェブサービス

関連

Posted in software | Tagged python, オープンソース
← Android関西 サイト全体の最新投稿ウィジェットの本文 →

アーカイブ

人気の投稿とページ

  • キンドル本を印刷する(PDFに変換する)方法
  • 名古屋駅から国際センターまでの道のり(徒歩)
  • AGPL ライセンス(GPLとは似ているが違いもある)
  • 6年使ったイーモバイル(Y!mobile)を解約手続。店頭でSIM返却
  • JP-Secure SiteGuard WP Pluginは不正ログイン防止に役立つか

プロフィール

水野史土:月70万PVホームページ制作会社のレスキューワーク株式会社で、PHPソフトウェアのサポートを行っている。concrete5コミュニティリーダー、Novius OSコアコード貢献者でもある。 詳しくは管理者詳細参照。
大好評WordPress書籍「WordPressユーザーのためのPHP入門 はじめから、ていねいに。」サポートページ

Copyright © 2015 Standing on the Shoulder of Linus.