Python 如何将各种文件中的文档包含到Sphinx中/阅读文档文档?

Python 如何将各种文件中的文档包含到Sphinx中/阅读文档文档?,python,python-sphinx,docstring,read-the-docs,Python,Python Sphinx,Docstring,Read The Docs,我只是想不通。我基本上有这样的库(简化): 我想要文档中某些文件的注释(docstring或其他格式):配置文件、脚本、snakefile。。。然而,我从斯芬克斯开始阅读文档,我找不到谷歌的任何帮助。我发现的大多数情况都假设人们使用具有特定结构的python模块 基本上,我希望能够在我的文档中写入此类内容: .. include:: <docstring from path/to/my/file> 。。包括: 并正确显示注释 这可能吗?。。。谢谢你的帮助 Sphinx可以自动记录

我只是想不通。我基本上有这样的库(简化):

我想要文档中某些文件的注释(docstring或其他格式):配置文件、脚本、snakefile。。。然而,我从斯芬克斯开始阅读文档,我找不到谷歌的任何帮助。我发现的大多数情况都假设人们使用具有特定结构的python模块

基本上,我希望能够在我的文档中写入此类内容:

.. include:: <docstring from path/to/my/file>
。。包括:
并正确显示注释


这可能吗?。。。谢谢你的帮助

Sphinx可以自动记录Python模块的docstring,但仅限于Python。对不起,我不知道还有其他支持的语言。
.. include:: <docstring from path/to/my/file>