Question

我已按照此guide设置了Sphinx。

我的目录如下：

/cms-service
  /documentation
    /modules
     models.rst

指南告诉我将路径放在models.rst中的python文件中。这条路应该是什么？显然.. automodule:: cms-service.apps.models不起作用，我在运行make html时遇到两个错误。 我想我需要上一个目录，但我不知道该怎么做。

错误：

CMS-服务/文档/模块/ models.rst：3：   警告：自动模块的签名无效（u＆＃39; cms-service.apps.models＆＃39;）

CMS-服务/文档/模块/ models.rst：3：   警告：不知道要导入哪个模块进行自动记录   ü＆＃39; CMS-service.apps.models＆＃39; （尝试放置＆＃34;模块＆＃34;或＆＃34; currentmodule＆＃34;   文档中的指令，或给出明确的模块名称）

欢迎任何其他有关如何设置Sphinx的指南。我已经好几天了......

Answer 1

虚拟，我搜索了同一个博客，继续使用Sphinx和Django进行autodoc进程。我认为教程中存在错误。

在module / models.rst文件中，在教程中它使用 project.app.models ，这样Sphinx无法找到要处理的模块。但是，如果您将其更改为 app.models ，则可以找到您的模块。

我认为我们不需要添加项目名称，因为它已在 conf.py 中指定。

sphinx备份一个目录

1 个答案: