python-sphinx - ReadTheDocs または Sphinx を使用して個人所有のドキュメントをホストする方法

Question

私はこのことにまったく慣れていません。「最も一般的に使用される」アプローチを理解するために丸一日を費やしました。私が実装したいのは、readthedocs.org のようなものですが、個人の顧客 (および独自のプロジェクト) 向けです。

ほとんどすべての FAQ、ブログ投稿、ハウツーなどで、GitHub ページまたは readthedocs.org (.com) を使用してドキュメントをホスト (公開) する方法が説明されています。

私はローカルで Sphinx (NB: "Sphinx Search" ではありません) を使用しようとしましたが、サンプルのデモ ドキュメントを非常に簡単に作成できましたが、そのような "検索可能な" ソリューションをホストする方法が正確にはわかりません。http://www.sphinx-doc.orgで動作します(ただし、検索バックエンドとして readthedocs.org を使用しているようです)。

readthedocs.org をローカルに展開しようとしましたが、次のようになります。

1. 「検索」は機能しません (誰も 127.0.0.1:9200 をリッスンしません)。
2. ドキュメントをビルドできませんでした (バージョンが見つからないか、プロジェクトが見つかりません)。
3. プライベート リポジトリ (ssh:) からプロジェクトを追加できませんでした

(注: 私は Windows で試していましたが、それは項目 1 から 2 を説明するかもしれませんが、3 は説明しないと思います。)

これまでのところ、私はアイデアを使い果たしたように感じます..

どんなアドバイスでも大歓迎です！

Answer 1

Sphinx ドキュメントをホストするために必要なのは、静的ファイル サーバーだけです (検索はバックエンドなしで機能します。こちらの回答を参照してください。

とはいえ、プライベートな readthedocs サーバーを使用するのは、おそらくオーバーエンジニアリングです。ファイルを静的ファイル サーバーに展開し、ベース URL (例: docs.myapp.com) をindex.htmlファイルに指定するだけです。

git hooksを使用してデプロイを自動化できます。

完全を期すために、プロジェクトをビルドするためにローカルの readthedocs サーバーを取得できると確信しています。ただし、readthedocs は明らかにオンプレミス展開用に設計されていないため、専門的なサポートを受けるのが難しい場合があります。私は、ローカルの readthedocs インスタンスのビルド/パフォーマンスの問題に苦労した後、Dev Ops チームが通常のツール セットを使用して展開を自動化する方が簡単であると判断したシナリオに関与していました。