如何阅读文档生成py-modindex.html?

时间:2016-08-29 00:26:40

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

我正在尝试阅读文档以生成py-modindex.html文件。对this question的研究引导我进行以下设置:

    项目目录中的
  • setup.py具有以下内容,这是使pytest工作所需的最低限度,并且自从我的项目部分工作以来没有更改过:

    import setuptools
    
    setuptools.setup(
        name='polygons',
        packages=setuptools.find_packages(),
    )
    
  • docs/requirements.txt包含一行:

    sphinx-autodoc-annotation
    
  • “阅读文档”存储库URL指向我的GitHub存储库。

  • 检查“使用setup.py install在virtualenv中安装项目”的RtD设置。
  • “需求文件”的RtD设置指向docs/requirements.txt

“模块索引”链接包含在index.html中,但缺少py-modindex.html文件。

我的理解是,使用上面的virtualenv设置,RtD将使用setup.py文件来安装项目,以便Sphinx可以读取Python文档字符串中的文档。我正在使用函数注释,并希望sphyinx-autodoc-annotation在创建构建的docs文件时使用它们。当我在make html文件夹中运行docs时,所有这些都在我的本地计算机上运行得非常好。现在我正试着让它继续阅读文档。

  

注意:在我将其应用到我的实际项目之前,这是我要了解的所有内容,多边形项目是占位符。

0 个答案:

没有答案