【问题标题】:How to publish sphinx-generated documentation on bitbucket wiki automatically?如何在 bitbucket wiki 上自动发布 sphinx 生成的文档?
【发布时间】:2013-02-19 00:27:46
【问题描述】:

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

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

【问题讨论】:

    标签: bitbucket python-sphinx


    【解决方案1】:

    不幸的是,这实际上是不可能的......

    您可以将您的 _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...

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

    附:有一个可重复使用的应用程序,可让您从 django 私下提供 sphinx 文档(受保护):django-docs ;) 您可以从您的 bitbucket *.rst 文件中构建它们...

    【讨论】:

    • 这看起来像是对事态的全面总结。谢谢。
    • 这似乎到今天仍然有效
    • 这在今天仍然有效。 2020 年 1 月
    • 截至 2021 年 12 月的今天似乎仍然有效
    猜你喜欢
    • 2020-02-10
    • 2018-09-07
    • 2015-06-22
    • 1970-01-01
    • 1970-01-01
    • 2012-10-31
    • 2010-12-05
    • 2018-06-12
    • 2018-03-02
    相关资源
    最近更新 更多