RTD のインストールはとても簡単で、以下にその手順を見てみましょう。
はじめに、まだインストールされていなければ Python と virtualenv をインストールして下さい。 仮想環境を使用すると、インストールが楽になりますし、システム全体のライブラリを汚さずに済みます。 また、リポジトリをクローンするには Git も必要です。
これらを導入した後は、自分の環境のどこでも構わないので仮想環境を作成して有効化します:
virtualenv rtd
cd rtd
source bin/activate
ここにフォルダを作成し、リポジトリをクローンしましょう:
mkdir checkouts
cd checkouts
git clone http://github.com/rtfd/readthedocs.org.git
次に pip (virtualenv に含まれています)を使って依存ライブラリをインストールします:
cd readthedocs.org
pip install -r pip_requirements.txt
これには少し時間がかかるので、飲み物でも飲んで待ちましょう。完了したらデータベースを構築します:
./manage.py syncdb
この処理の中で Django の管理者アカウントを作成するか聞かれるので、作成しましょう。次に以下を実行します:
./manage.py migrate
お好みで、いくつかのテストプロジェクトを読み込むことができます:
./manage.py loaddata test_data
./manage.py update_repos
または上記ステップを飛ばして、まっさらなサイトとして開始することもできます。 これで Web サーバを起動する準備ができました:
./manage.py runserver
それではブラウザで http://127.0.0.1:8000/ を開いてみましょう; 先程作成した管理者アカウントでログインすれば http://127.0.0.1:8000/admin から管理者画面を使うこともできます。
サイトにアカウント登録(または自身を管理者アカウントとして作成)すると、ログインして ダッシュボード 画面を閲覧することができます。
ダッシュボードでは、新規ドキュメントを作成したり、git や mercurial リポジトリ上の既存ドキュメントを取り込むことができます。
readthedocs.org の目的のひとつに、どんなオープンソース開発者でも簡単に、 クオリティが高く、見た目もいいホスティングされたドキュメントを作成できるようにしたい、というものがあります。 そこで、新規プロジェクトを作成するたびに、シンプルなエディタとふたつのサンプルページを提供しています。 それらの項目を埋めるだけで、ドキュメントのビルド、ファイルの全リビジョンの履歴閲覧などが可能になります。 また今後数週間から数ヶ月のうちに、もっと機能を追加していく予定です。
readthedocs.org には、既にビルドされたドキュメントをホスティングできるという側面もあります。 複製元リポジトリの URL を指定するだけで、コードを取り込んでドキュメントを抜き出し、それらをビルドしてくれるのです！ 更に提供しているポストコミット Web フックを使えば、自分のリポジトリにドキュメントをコミットした時に、このサイトのドキュメントも更新されるように設定することができます。 実際「一度設定したら忘れてOK」な状態にできるのです。
このサイトは自動取り込み後に conf.py ファイルを生成しています。 そのため特殊な拡張やテーマ、テンプレートを使用しているプロジェクトは、正しく動作しません。 これは python ファイル内のコードの実行を制限しているためです。 ゆくゆくは人気のあるテーマの導入や、認定されたホワイトリストユーザーへの制限の解除なども計画しています。