gpt4 book ai didi

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

转载 作者:行者123 更新时间:2023-12-03 14:43:29 25 4
gpt4 key购买 nike

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

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

最佳答案

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

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

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

它会显示它们,但包含 _static css/js 文件将不起作用,因此您的文档会看起来很丑:(

你也可以 publish your docs as a website on BitBucket但是没有隐私,即使您的仓库是私有(private)的,您的文档也将是公开的,所以这不是很有用,那么您可以使用 read the docs ...

实际阅读文档 supports privacy因此您可以在私有(private)模式下添加您的文档并添加 Webhook在比特桶中。不幸的是,这只适用于公共(public) repo ,所以也不是一个很好的解决方案......

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

关于bitbucket - 如何在 bitbucket wiki 上自动发布 sphinx 生成的文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/14947790/

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com