Python 我该如何构造一个“;斯芬克斯“;记录git回购以记录其他回购作为子模块?

Python 我该如何构造一个“;斯芬克斯“;记录git回购以记录其他回购作为子模块?,python,git,python-sphinx,git-submodules,Python,Git,Python Sphinx,Git Submodules,我有多个git回购协议,它们组成了一个更大的库 我想创建一个“sphinx”文档回购协议,将其他回购协议作为子模块引用,并在“sphinx”回购协议中构建文档。sphinx repo文档树将作为大型库的文档发布。每当更新任何成分回购协议时,将重新生成该协议 我也在使用autodoc和napoleon扩展 我有一个shell脚本,它遍历运行sphinx apidoc的子模块,然后在顶层目录中运行make html: SPHINX_APIDOC_OPTIONS='members,undoc-memb

我有多个git回购协议,它们组成了一个更大的库

我想创建一个“sphinx”文档回购协议,将其他回购协议作为子模块引用,并在“sphinx”回购协议中构建文档。sphinx repo文档树将作为大型库的文档发布。每当更新任何成分回购协议时,将重新生成该协议

我也在使用autodoc和napoleon扩展

我有一个shell脚本,它遍历运行sphinx apidoc的子模块,然后在顶层目录中运行make html:

SPHINX_APIDOC_OPTIONS='members,undoc-members,inherited-members,show-inheritance'

for dir in `find * -type d | egrep -v "(^_)|(^\.)"`; do
    sphinx-apidoc -f -e -a -o _build/docs/${dir} ${dir};
done

make html
顶级index.rst文件:

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   _build/docs/module1/modules.rst
   _build/docs/module2/modules.rst
(子模块没有index.rst文件。)

子模块只在浅层中链接,因此子模块中的类文件夹不会显示。我尝试过各种变体,但每种变体都有不同的缺陷

有没有人举一个简单的例子来说明如何将其组合在一起?我肯定错过了一些基本的东西

更新:添加了第一页的屏幕截图

要求:创建一个Sphinx“project”文件夹,包括任何构建脚本和index.rst文件,并带有指向本地git项目文件夹的软链接,以便所有链接项目的所有文档可以自动缝合在一个位置?然后,作为自动构建流程的一部分,可以发布构建文档文件夹,例如发布到AWS S3


要求不明确。你能把生成的HTML的快照放进去吗?为什么生成的HTML会澄清需求?当然可以。你现在知道怎么做了吗?@mpairente没有。发布后不久,我换了工作,没有跟进。