Commits

ae35  committed bf4be72

add readthedocs.rst

  • Participants

Comments (0)

Files changed (1)

File readthdocs.rst

+======================
+ Read The Docs の紹介
+======================
+
+:日付: 2010-11-10
+
+言いたいこと
+============
+
+- 便利だからみんなも使ってみるといいよ
+  
+- Django のアプリ構築のお勉強にもなるから、ソース読むます
+
+
+もくじ
+======
+
+- Read The Docs とは?
+  
+- 気になったきっかけ
+  
+- 動いてるとこを見てみよう
+  
+- アプリ構成
+  
+- ドキュメント和訳したよ
+
+- ちょっと気になったとこ
+
+
+
+Read The Docs とは?
+====================
+
+`Read The Docs <http://readthedocs.org/>`_ は Django で作られた
+**Shpinx ドキュメントのホスティングサービス** です。
+
+- リポジトリで管理している Sphinx ドキュメントをインポートできます
+  
+- リポジトリで変更されたドキュメントを自動で取得、ビルドしてくれます
+  
+- リポジトリが無くてもリッチテキストエディタでサイト上で文書作成できます
+
+
+気になったきっかけ 1
+====================
+
+Django Dash 2010 の 3 位入賞チームだった
+
+審査員の Jeff さんの素敵な評価
+------------------------------
+
+- Level Of Polish: Template code looks great and is really clean.
+  
+- Code Quality: Lots of code and it looks clean.
+  
+- Design: Great design.
+  
+- Innovation: Great idea and solves needed problem.
+
+
+気になったきっかけ 2
+====================
+
+個人的にグッと来た点
+
+- Sphinx ドキュメントの公開先を迷うことが多かったので嬉しい
+
+- UI がおしゃれシンプルで使いやすい
+
+- Django で作られてる & ソース公開されてるのでお勉強になるなぁ
+
+
+動いてるとこを見てみよう
+========================
+
+どうぞ
+
+
+アプリ構成
+==========
+
+pip_requirements.txt::
+
+  django==1.2.1
+  docutils
+  simplejson
+  sphinx
+  celery
+  django-celery
+  ghettoq
+  django-extensions
+  django-haystack
+  django-profiles
+  -e git+http://github.com/nathanborror/django-basic-apps.git#egg=basic
+  -e hg+http://bitbucket.org/andrewgodwin/south/#egg=south
+  -e git+http://github.com/alex/django-taggit.git#egg=taggit
+  -e git+http://github.com/ericflo/django-pagination.git#egg=pagination
+  -e git+http://github.com/nathanborror/django-registration.git#egg=django-registration
+
+.. その他
+   ------
+
+   ::
+
+     $ pip install python-memcache
+     $ pip install pysolr
+
+.. update_repos
+   ------------
+
+   全ての登録プロジェクトのドキュメントを再構築する::
+
+     $ ./manage.py update_repos
+
+
+ドキュメント和訳したよ
+======================
+
+和訳したドキュメントを Read The Docs にあげといた。
+
+http://readthedocs.org/projects/AE35/readthedocs-doc-ja/docs/
+
+
+ちょっと気になったとこ
+======================
+
+1. ヘッダーテンプレートのリンクが readthedocs.org 決め打ち
+
+2. なぜだか Web フックが動かないことが多々ある
+
+3. autodoc などの拡張が動かない(ホワイトリストユーザーじゃないとダメ?)
+
+
+最後にもう一度
+==============
+
+- 便利だからみんなも使ってみるといいよ
+  
+- Django のアプリ構築のお勉強にもなるから、ソース読むます
+