如何自动在bitbucket wiki上发布sphinx生成的文档?

时间:2013-02-19 00:27:46

标签: documentation bitbucket python-sphinx

我有一个带有sphinx生成的文档的python包(使用自动模块功能),它可以被制作成一组静态html页面,位于项目的git存储库的_build目录中。我想在bitbucket上以漂亮的和私有的方式查看此文档。似乎wiki是一个git repo本身可能是可用的。

是否有一个简单的序列步骤可以将我的html文档转换为标记并将其推送到bitbucket wiki存储库?

1 个答案:

答案 0 :(得分:25)

不幸的是,这真的不可能......

你可以将你的_build目录推送到wiki仓库并在wiki(Home.rst)中创建链接到你的html文件,如下所示:

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

它会显示它们但是包含_static css / js文件将无效,所以你的文档看起来很难看:(

您也可以publish your docs as a website on BitBucket但是没有隐私,即使您的回购是私有的,您的文档也会公开,所以这不是很有用,那么您可以使用read the docs ... < / p>

实际阅读文档supports privacy,以便您可以在私人模式下添加文档,并在BitBucket中添加Webhook。不幸的是,这只适用于公共回购,所以不是一个很好的解决方案......

P.S。有一个可重复使用的应用程序,允许您私下提供来自django(受保护)的sphinx文档:django-docs;) 你可以用你的bitbucket * .rst文件构建那些......