如何将各种文件中的文档包含到Sphinx / Read The Docs文档中?

时间:2017-03-28 15:24:29

标签: python python-sphinx docstring read-the-docs

我似乎无法弄清楚这一点。我基本上(简化)有这种库:

Library
 |doc
 | scripts
   | make
     | makefiles
   | R
     | R scripts
   | snakemake
     | snakefiles
 | config

我想从我的文档中包含的某些文件中获得评论(docstring或其他格式):配置文件,脚本,snakefile ......但是我开始使用Sphinx和Read The Docs,我找不到帮助谷歌无论如何。我发现的大多数事情都假设人们正在处理具有特定结构的python模块。

基本上我希望能够在我的文档中写出这样的东西:

.. include:: <docstring from path/to/my/file>

并正确显示评论。

这有可能吗?...感谢您的帮助!

0 个答案:

没有答案