readthedocs/readthedocs.org

これは何？

主な機能

• 01ドキュメントのソースをGitリポジトリから直接取得します。
• 02プッシュのたびにSphinxとMkDocsのプロジェクトを自動でビルドします。
• 03ドキュメントの複数のバージョンを管理し、公開します。
• 04ビルドしたドキュメントを公開サイトまたは非公開サイトでホスティングします。

ユースケース

• オープンソースプロジェクトの公開APIドキュメントやライブラリドキュメントをホスティングする。
• コミットのたびに更新されるチーム内ドキュメントを公開する。
• ユーザーがインストールしたバージョンに対応するリリースのドキュメントを読めるよう、バージョン別に公開する。

クイックスタート

1. 1

   GitHubアカウントでRead the Docsに登録します

2. 2

   GitHubから求められたら、リポジトリへのアクセスを許可します

3. 3

   ログインし、「プロジェクトを追加」をクリックしてリポジトリを選択し、「続行」をクリックします

4. 4

   プロジェクトの詳細を確認して「次へ」をクリックし、コミットをpushするとドキュメントが自動更新されます

使う前に知っておきたいこと

• !ホステッドサービスはドキュメントプロジェクト向けに設計されており、プラットフォーム全体をセルフホストするにはかなりの労力が必要です。
• !コードベースは依存関係の多い大規模なDjangoアプリケーションのため、ローカル開発環境のセットアップには手間がかかります。

収録されている特集

トピック

よくある質問

readthedocs.org とは？

Gitリポジトリからドキュメントを自動でビルド、バージョン管理、ホスティングするオープンソースのプラットフォーム。SphinxとMkDocsに対応。 Read the Docsは、オープンソースプロジェクトやチームのドキュメントをホスティングします。Gitリポジトリからドキュメントを取得し、Sphinx（reStructuredText）やMkDocs（Markdown）などのツールでビルドして、ホスティングサイトで公開します。

readthedocs.org は無料で使えますか？ライセンスは？

readthedocs.org は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

readthedocs.org は今もメンテナンスされていますか？

活発にメンテナンス中。readthedocs.org の最終コミットは 2026年11月6日 です。

readthedocs.org は何に使えますか？

オープンソースプロジェクトの公開APIドキュメントやライブラリドキュメントをホスティングする。 コミットのたびに更新されるチーム内ドキュメントを公開する。 ユーザーがインストールしたバージョンに対応するリリースのドキュメントを読めるよう、バージョン別に公開する。

readthedocs.org のインストール方法は？

GitHubアカウントでRead the Docsに登録します GitHubから求められたら、リポジトリへのアクセスを許可します ログインし、「プロジェクトを追加」をクリックしてリポジトリを選択し、「続行」をクリックします プロジェクトの詳細を確認して「次へ」をクリックし、コミットをpushするとドキュメントが自動更新されます

readthedocs.org はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/readthedocs/readthedocs.org