[Django]: Python温泉#00の成果発表

Python温泉#00 で作ってたやつです。 ReSTフォーマットのテキストを表示する views を app としてまとめてみました。 ( source )

名付けて「HelpDoc」。 Django オンラインドキュメント和訳 を表示しているものと同じです。 Python温泉で出来上がったつもりでいましたが、実は全然できてなくてビックリ。 naming url patterns が、なぜ必要なのかを痛感するのでした。

本家 Django では 「実装とドキュメントとテスト」がセットで開発されているようですが、自分でアプリを作る場合に「じゃぁ、ドキュメントはどこに置くのよ？」ということで作ってみました。 管理画面からアクセスできるところに置けば、運用スタッフもアクセスし易く、更新も最新版の配布もらくちんじゃないかと。 作った人だけがわかっていてドキュメントがない、ということになりがちなので、これを機に書くようにしたいと思います :-p

大まかな動作を。

• Django 0.96 以降。
• Django administration の Documentation (admin/doc/) に Help Documentations (/helpdoc/) が追加されます。
• settings.INSTALLED_APPS にリストされ、且つ <app>/docs ディレクトリを持つ app が対象です。
• 対象の app は Help Documentations にアンカーがリストされます。 permission_required("is_staff") になっています。
• <app>/docs 直下のファイルが表示の対象です。 "index.txt" がトップページです。 textile, markdown, restructuredtext, html に対応(してるつもり)。
• レンダする views 自体は Generic Views のように使うことも可能です。
• おまけで sitemap 用の class が付いてます。

まだ肝心のドキュメントを書いてない(！)ので、書き上がったらデモを兼ねてエントリーしよう。