19

私は(自動モジュール機能を使用して)sphinxで生成されたドキュメントを含むPythonパッケージを持っており、プロジェクトのgitリポジトリの_buildディレクトリにある静的なhtmlページのセットにすることができます。このドキュメントをbitbucketできれいにプライベートな方法で表示したいと思います。gitリポジトリ自体であるwikiがそのために使えるかもしれないようです。

HTMLドキュメントをマークアップに変換/変換してbitbucketwikiリポジトリにプッシュできるシーケンスの簡単なステップはありますか?

4

1 に答える 1

31

残念ながら、これは実際には不可能です...

_buildディレクトリをwikiリポジトリにプッシュし、wiki(Home.rst)に次のようにhtmlファイルへのリンクを作成できます。

`Sphinx docs <_build/html/index.html>`_

そして、それらは表示されますが、_static css / jsファイルを含めることは機能しないため、ドキュメントは見苦しくなります:(

ドキュメントをBitBucketのウェブサイトとして公開することもできますが、プライバシーはありません。リポジトリが非公開であってもドキュメントは公開されるため、これはあまり役に立ちません。ドキュメントを読んでください...

ドキュメントを読んで実際にプライバシーをサポートしているので、プライベートモードでドキュメントを追加し、BitBucketでWebhookを追加できます。残念ながら、これはパブリックリポジトリでのみ機能するため、優れたソリューションでもありません...

PS django(保護された)からスフィンクスドキュメントをプライベートに提供できる再利用可能なアプリがあります:django-docs ;)そしてビットバケット*.rstファイルからそれらをビルドできます...

于 2013-04-29T08:24:09.840 に答える