让 Sphinx 从 Python 文档字符串生成重组文本页面
Make Sphinx generate reStructuredText pages from Python docstrings
我有一个免费的私有 github 存储库。我想在 docs
文件夹中将文档字符串转换为第一个文件。
这就是 sphinx 所做的,但是生成 html
而不是 rst
.
对于以这种方式生成的所有第一个文件(让我们想象每个 python 模块一个第一个文件),我打算从自述文件中超链接它以通过这种方式访问代码文档(而不必依赖github 个我无法访问的页面,因为我有一个免费帐户)。
请问,这可能吗?
理想情况下,我需要一种方法来告诉 sphinx autodoc
扩展在 rst 而不是 html 中生成文档,但我还没有找到这种方法。
是否有另一个库?
感谢您的帮助,
最佳,
正如@mzjn 在评论中所提议的那样,我为此使用了 sphinxcontrib-restbuilder
。
超链接有效,这非常适合我的需要。
我把它应用到我的一个 public 项目的 sphinx 文档中,并上传到 this github repo 以供愿意看的人使用。
点击index.rst
并跟随阅读。确实有一些小故障。
API 记录在 api.rst
中。这确实是我感兴趣的部分。
我觉得还不错。
我有一个免费的私有 github 存储库。我想在 docs
文件夹中将文档字符串转换为第一个文件。
这就是 sphinx 所做的,但是生成 html
而不是 rst
.
对于以这种方式生成的所有第一个文件(让我们想象每个 python 模块一个第一个文件),我打算从自述文件中超链接它以通过这种方式访问代码文档(而不必依赖github 个我无法访问的页面,因为我有一个免费帐户)。
请问,这可能吗?
理想情况下,我需要一种方法来告诉 sphinx autodoc
扩展在 rst 而不是 html 中生成文档,但我还没有找到这种方法。
是否有另一个库?
感谢您的帮助, 最佳,
正如@mzjn 在评论中所提议的那样,我为此使用了 sphinxcontrib-restbuilder
。
超链接有效,这非常适合我的需要。
我把它应用到我的一个 public 项目的 sphinx 文档中,并上传到 this github repo 以供愿意看的人使用。
点击index.rst
并跟随阅读。确实有一些小故障。
API 记录在 api.rst
中。这确实是我感兴趣的部分。
我觉得还不错。