sphinx备份一个目录

Question

我跟着这个guide建立了Sphinx。

我的目录如下：

/cms-service
  /documentation
    /modules
     models.rst

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

错误：

cms-service / documentation / modules / models.rst：3：警告：自动模块的签名无效（u'cms-service.apps.models'）

cms-service / documentation / modules / models.rst：3：警告：不知道要导入哪个模块来自动记录u'cms-service.apps.models'（尝试在其中放置“module”或“currentmodule”指令文档，或给出明确的模块名称）

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

Answer 1

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

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

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