2013-02-19 52 views
12

我有一个使用sphinx生成的文档(使用automodules特性)的python包,它可以制作成一组静态HTML页面,位于项目的git存储库的_build目录中。我想在bitbucket上查看这个漂亮的文档和专用的。看起来这是一个git回购本身的wiki可能可用于此。如何自动发布sphinx生成的关于bitbucket wiki的文档?

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

回答

20

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

你可以把你的_build目录的wiki回购和创建维基(Home.rst)到你的HTML文件,像这样的链接:

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

它会显示出来,但列入_static CSS/JS文件将无法正常工作,那么您的文档看起来会比较难看:(

你也可以publish your docs as a website on BitBucket但没有隐私,即使你的回购您的文档将被公开是私人的,所以这不是很有用, n您可以去与read the docs ...

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

P.S.有一个可重复使用的应用程序,允许你私自从Django的(保护)为你的狮身人面像文档:django-docs;) 你可以建立那些从到位桶* .rst文件...

+0

看起来像状态的全面总结的事务。谢谢。 – DrSAR 2013-04-30 14:33:08

+3

这看起来像今天仍然有效 – shadi 2017-11-15 05:03:54

相关问题