Pythonパッケージのドキュメントをオンラインで公開する方法#
Pythonパッケージドキュメントのホスティングサービスをセットアップすることをお勧めします。 ドキュメンテーションウェブサイトのホスティング環境を素早く作るための、無料でよく使われる2つの方法を以下に示します。
GitHub Pages や他のオンラインホスティングサービスを使って、ドキュメントを自分でホスティングすることができます。
Read the Docs を使ってドキュメントをホストすることができます。
Read the Docsとは？#
Read the Docs は、あなたのプロジェクトのドキュメント公開をサポートするドキュメントホスティングサービスです。
Read the Docsは、完全な機能を備えた無料のドキュメントホスティングサービスです。 その多くの機能の一部を紹介します:
ドキュメントのホスティングは無料です(ただし、ホスティングをカスタマイズしたい場合は、有料の階層もあります)
ドキュメントの作成を自動化する
プルリクエストとの統合を有効にすると、ドキュメントのビルドの進捗状況（成功か失敗か）を確認できます。
ドキュメントのバージョン管理をサポートし、ユーザーが古いバージョンのパッケージを使用している場合、タグ付けされた古いバージョンのドキュメントを参照できるようにします。
PDFやその他の形式のドキュメントのダウンロードに対応。
ドキュメントのビルドは、GitHubリポジトリの .readthedocs.yaml ファイルを使ってカスタマイズできます。
GitHub Pagesとは？#
GitHub Pages は GitHub が提供する無料のウェブホスティングサービスです。 GitHub Pages を使えば、ローカルあるいは継続的インテグレーションを使ってドキュメントをビルドし、GitHub Pages のウェブビルドを実行するように設定した GitHub リポジトリのブランチにプッシュすることができます。
Read the Docs vs GitHub Pages#
GitHub pages は、ドキュメントのデプロイに最適な選択肢です。 しかし、GitHub pages を使う場合はドキュメントのビルドやデプロイに少し手間がかかります。
Read the Docsは、Read the Docsのユーザーアカウントで設定できます。 このサービスは、ドキュメントの作成と配布の全プロセスを自動化します。
Pythonパッケージのドキュメントのウェブサイトを管理したくない場合は、Read the Docsウェブサイトを使うことをお勧めします。