ITエンジニア/デザイナ向けにオープンソースを毎日紹介

Read the DocsはDjango製のドキュメントビューワーで、Python向けのドキュメントフォーマットSphinxに対応しています。

Pythonで作られたソフトウェア、ライブラリのドキュメントを閲覧、検索できるソフトウェアがRead the Docsです。Sphinxで書かれたドキュメントを読み取り、リッチな表示をしてくれます。


トップページです。様々なプロジェクトが登録されています。


登録されているソフトウェアのトップページです。バージョンやリポジトリなどの情報も載っています。ここからePubやmanpageのダウンロードもできます。


ビルドのリザルト一覧です。


ドキュメントです。右側に見出しが並んでいて左側に内容が記載されています。


次のトピックにも対応していてさくさく読めます。


検索機能ももちろんあります。


ユーザごとの参加プロジェクトです。

Read the DocsはDjangoで作られていて、企業などで作ったPythonプロジェクトのドキュメントをSphinxで書いて取り込んだりすると見栄えのいいドキュメントが作れるかも知れません。プロジェクトはGit/Hg/Bazzer/Subversionといったリポジトリからの取り込みに対応しています。バージョンごとのドキュメント化も可能です。

Read the DocsはPython/Django製、MIT Licenseのオープンソース・ソフトウェアです。


MOONGIFTはこう見る

オープンソースに限らずライブラリやシステムのドキュメントは必要です。無理に多く書く必要はありませんが、会社でチームで開発を行っている以上、誰か別な人が改修を行うことになったとしても困らないような準備はしておいた方が良いでしょう。その時のドキュメント作成に使えそうです。

単なるテキストファイルでは見栄えも悪く、必要な情報を探すのも大変ですがWebベースであれば探すのは容易です。何より見栄えのいいドキュメントを作成するのは執筆者のモチベーションも高くなります。適切なドキュメントを書いて日々の開発をスムーズにしていきましょう。

Home | Read the Docs

rtfd/readthedocs.org - GitHub

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2