タグ

Pythonとdocumentationに関するxiangzeのブックマーク (2)

  • Doxygen vs. Sphinx+Breathe

    ソースコードに埋め込まれたコメントから文書を生成するツールとして,DoxygenとSphinx+Breatheについて検討し,Doxygen単独での利用が妥当と結論づけた。そのことについてメモしておく。 一連の考察は以下でまとめたツイートがベースとなっている。 Doxygen vs. Sphinx+Breathe – Togetterまとめ Introductionソフトウェアを開発していると,そのソフトのクラスの構成や使い方,概念などが複雑になってくることがある。また,会社など複数人で開発を行っていると,新しく参加する人のためであったり,数年後に忘れた時のために,APIの説明文書(API文書)があるととても役に立つ。 しかし,こうしたAPI文書を作成する労力は無視できない。また以下の点も文書整備の妨げとなるだろう。 ソフトウェアの更新。 文書整備の優先度の低さ。 こうした問題があるため,

    Doxygen vs. Sphinx+Breathe
  • ドキュメントを作りたくなってしまう魔法のツールSphinx

    http://sphinx-users.jp/event/20101203_jus_benkyoukai.htmlUNIXユーザ会 2010年12月勉強会 (2010/12/3) 日UNIXユーザ会の2010年12月の勉強会にて、以下の内容で発表させていただきました。 「ドキュメントを作りたくなってしまう魔法のツール Sphinx」Read less

    ドキュメントを作りたくなってしまう魔法のツールSphinx
  • 1