2012-06-19 24 views
13

私は現在、かなり複雑なDjango WebサイトのためにSphinxを使っていくつかの豊富なドキュメントを書いています。私はこれを社内で取り組んできました。私がすぐに出発する前に、サイトの新しい開発者/管理者がアクセスできる詳細なドキュメントを残したいと思います。プライベートSphinxドキュメントのホスティング

私の質問は、このドキュメントのホストオプションです。私はそれが私的であることを好むだろう。また、ドキュメントはPythonパッケージではなくウェブサイトに関するものです。この2つの理由から私は、Docsを読むことが最も適切な選択肢ではないかもしれないと考えています。

これはバックスタンドとしてHaystackを設定する必要がありますが、私はdjango-sphinxdocを実行しました。組み込みのjs検索を使用してドキュメントを単にサーバーに送る方法はありませんか?または、ドキュメントのプライベートホスティングを可能にするサービスですか?

いずれのオプションも大歓迎です。

答えて

14

スフィンクスは、スタティック.htmlファイル(make html)を生成することができます。それらのHTMLファイルを内部のWebサーバー上に置くとよいです。

+0

これはjs検索で機能しますか? –

+2

JS検索は静的インデックス(ドキュメントを構築するときに構築されます)を持つ単なるJSです。 –

6

個人的にドキュメントをホストする必要性も感じました。そこで私は、Sphinxのプライベートなドキュメントホスティング:HasDocsをサポートするWebサービスを構築しました。

http://www.hasdocs.com/

それはあなたがあなたのGitHubのリポジトリと権限を同期することができますなど、独自のWebサーバーをセットアップする必要を排除する必要があります。プライベートプロジェクトには、適切な権限を持つユーザーだけがアクセスできるプライベートドキュメントがあります。新しいコードをGitHubリポジトリにプッシュするたびにドキュメントが再構築されます。

現在ベータ版であり、ドキュメント生成ツールとしてSphinx、Jekyll、Javadocをサポートしています。試してみてください、そして、どんなフィードバックも高く評価されます。

+0

bitbucketをサポートしていますか? –

+4

http://www.hasdocs.comがなくなっているように見えます。他の誰かがこれに対して良い解決策を持っていますか? –

+0

@BrianKingはソースが[https://github.com/narrowcast/hasdocs.com](https://github.com/narrowcast/hasdocs.com)で利用可能になっているようです。 – Reinbach

-1

回答を見るquestion(完全な開示、私は質問をしましたが、いくつかの研究とコーディングを行って回答を掲載しましたので、そこではより良いものがあるかもしれません。もし誰かがそれらを指摘するならば)

このgitlabレポは、実例hereを示しています。

用途static password protectionであり、このissueでも説明しています。

関連する問題