使用现有项目设置 Sphinx Autodoc

Question

我是 Sphinx 的新手，看了几个小时的教程，但找不到问题的答案

我当前的项目结构如下

-project folder
 |-sub folder 1
 | |- sub folder 1.a
 |    | - ...
 |-sub folder 2
 | |- sub folder 2.a
 |    | - ...
 |-sub folder 3
 | |- sub folder 3.a
 |    | - ...
 |- .py files
 |...
 |- conf.py
 |- index.rst
 |- Makefile
 |- _build/
 |  |-doctrees/
 |  |-html/
 |    |...(all the html files generated by "make html")

我在 conf.py

中包含了以下内容

extensions = ['autoapi.extension']
# Document Python Code
autoapi_type = 'python'
autoapi_dir = '../project folder'

在每个子文件夹中，我都有 .py 文件，其中包含类、函数、模块、成员，所有这些都需要记录在案。有没有办法让 sphinx 解析当前项目文件夹及其所有子目录以搜索 .py 文件到 autodoc？如果是这样，我将如何设置我的 index.rst 和 conf.py 文件来实现这一点？

我看到的错误如下：

Removing everything under '_build'...
Running Sphinx v1.8.5  
making output directory...  

Extension error: 
You must configure an autoapi_dirs setting  
Makefile:19: recipe for target 'html' failed 
make: *** [html] Error 2

Answer 1

错误很明显：You must configure an autoapi_dirs setting。您的 conf.py 设置中有一个拼写错误，在您的设置 autoapi_dir 中省略了 "s"。查看 autoapi_dirs for autoapi.

的配置值

使用现有项目设置 Sphinx Autodoc

Setting up Sphinx Autodoc with existing project

python-sphinx

autodoc

sphinx-apidoc