目前,我们使用 GitHub 来存储代码库,其中包括用于文档的 HTML 文件。在 GitHub 上,存储库中的 HTML 文件仅显示 HTML 源代码,但我可以将其发布到 GitHub Pages,在其中向我的用户显示为常规网页。
我们刚刚开始迁移到我的组织内托管的 BitBucket。看起来 BitBucket Pages 插件相当于 GitHub Pages,但我们没有该插件,我也不希望得到它。如果没有这个插件,有没有办法将 HTML 文件显示为网页?我们还有 JIRA 和 Confluence,以防它们有帮助。
我目前使用 pdoc (pdoc3) 记录我的 Python 代码以创建 HTML 文档。我不认为这个问题是 Python 或 pdoc3 特有的,但我只是想补充一下,以防万一它很重要。(我喜欢 pdoc3,但如果其他工具解决了我的问题,我会尝试它。)
简而言之,如何在没有 Pages 插件的情况下在 BitBucket 中显示 HTML?
我正在尝试使用 pdoc 生成文档,其中我的文档字符串如下所示:
"""
I am a description of what a method does
:param param1: an integer
:param param2: a str
"""
Run Code Online (Sandbox Code Playgroud)
我发现了这个问题:如何在使用 sphinx 生成 python 文档时保留换行符,但建议在每一行前加上 | 对我不起作用(它只是像这样出现)
| :param param1: an integer | :param param2: a str
Run Code Online (Sandbox Code Playgroud)
除了在每一行的末尾使用 \n 之外,还有什么想法吗?