从Python Docstrings生成手册页

Question

我熟悉使用sphinx记录python项目。我正在编写一些小脚本 - 目前是自包含的脚本，但在某些时候可能会包含在一个更大的python项目中。我很好奇是否有现有的方法或众所周知的工具，使用与sphinx兼容的文档字符串为自包含脚本（或几个文件）构建手册页。

Answer 1

既然您熟悉 Sphinx，为什么不利用它将脚本中的文档字符串发布到一个或多个手册页，至少作为起点。您可以根据需要调整生成的代码以完善格式。

如果您在使用此方法时遇到障碍，请更新您的问题以描述您尝试过的方法，以便我们可以解决这些问题。