私はこのことにまったく新しいです。 「最も一般的に使用されている」アプローチを理解するために一日中過ごしました。私が実装したいのは、readthedocs.orgのようなものですが、個人の顧客(およびプロプライエタリプロジェクト)向けです。
ほぼすべてのFAQ、ブログ投稿、ハウツーなどが、GitHubページまたはreadthedocs.org(.com)でドキュメントをホスト(公開)する方法を説明しています
Sphinx(NB:[〜#〜] not [〜#〜] "Sphinx Search")をローカルで使用しようとしましたが、サンプルデモドキュメントを非常に簡単に作成できますが、「検索可能な」ソリューションをホストする方法がわかりません。たとえば、 http://www.sphinx-doc.orgで機能します。 (ただし、readthedocs.orgを検索バックエンドとして使用しているようです)。
Readthedocs.orgをローカルにデプロイしようとしましたが、
(注:私はWindowsでそれを試していました、そしてそれは項目1を説明するかもしれませんが、3を説明しないかもしれません、私は信じます。)
これまでのところ、アイデアが足りなくなったような気がします。
どんなアドバイスでも大歓迎です!
Sphinxのドキュメントをホストするために必要なのは、静的ファイルサーバーだけです(検索はバックエンドなしで機能します。- 私の答えはこちら を参照してください)。
とはいえ、プライベートなreadthedocsサーバーを使用することは、おそらく過剰なエンジニアリングです。ファイルを静的ファイルサーバーにデプロイし、ベースURLを指定するだけです(例:docs.myapp.com
)からindex.html
ファイル。
git hooks を使用してデプロイメントを自動化できます。
完全を期すために、ローカルのreadthedocsサーバーを入手してプロジェクトをビルドすることは可能だと思います。しかし、readthedocsは明らかにオンプレミス展開用に設計されておらず、専門的なサポートを受けるのが難しい場合があります。私は、Dev Opsチームがローカルのreadthedocsインスタンスのビルド/パフォーマンスの問題に苦労した後、通常のツールセットを使用して展開を自動化する方が簡単であると判断したシナリオに関与していました。