我一直在尝试使用sphinx编写一系列python文件的文档。它适用于其中一些,但不是全部。
使用sphinx-apidoc之后,将为所有python文件创建rst文件,当我使用make html时,将创建所有html文件,但是当我打开它们时,有些空白,而不是显示所有注释。
所有html文件都出现在modules.html文件中,但有些没有出现在index.html中。
知道为什么会这样吗?
编辑:
我不确定在不直接上传整个库的情况下如何提供更多详细信息。我在Pycharm上运行sphinx quickstart,此后,我运行:sphinx-apidoc -o ./source -f ./这将为每个.py文件创建一个rst文件。之后,我运行make html,这将为每个模块创建一个html文件,但是当我打开这些html文件时,尽管我以相同的样式对其进行了注释,但没有文档。这些文件也不会出现在index.html文件中,但是会出现在modules.html文件中。
当我运行make html时,我得到以下警告:从docs.python.org/objects.inv中加载Intersphinx库存。 python.org/objects.inv';由于以下原因不可获取:(“ intersphinx库存%r由于%s无法获取:%s”,“ docs.python.org/objects.inv”、``、ConnectionError(...))D:\ SLiM Testing \ source \ modules.rst:警告:文档未包含在任何toctree中–
过去,我也收到与未出现在索引中的.py文件有关的警告:尝试在文档中放置“ module”或“ currentmodule”指令,或给出明确的模块名称,但这停止显示。
编辑2: 我看不到如何提供更多信息,但是,这可能会有所帮助,如果我复制了一个可以与sphinx一起使用的python文件并重新运行sphinx,则对于新文件,它会带来完全相同的问题。为python文件的副本创建的html文件,但html文件为空,并且未出现在索引中。因此,问题一定出在我试图运行狮身人面像的方式上,我必须缺少一些东西,有人可以一步一步地介绍如何在pycharm中正确运行狮身人面像吗? 再次感谢您的所有帮助
编辑3: 使用此链接上的程序,您能否概述如何在Pycharm中使用sphinx创建文档?我现在必须错过一个步骤,因为它以前和现在都可以创建一个空的html文件。 http://www.sphinx-doc.org/en/stable/ext/example_google.html 谢谢
编辑4: 我发现了问题,某些新文件(包括复制的文件)的名称中带有空格。现在可以使用了。谢谢。