Настройка Sphinx Autodoc с существующим проектом - PullRequest
0 голосов
/ 18 апреля 2019

Я совершенно новичок в 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 

1 Ответ

0 голосов
/ 19 апреля 2019

Ошибка явная: You must configure an autoapi_dirs setting.У вас есть опечатка в настройке conf.py, опуская "s" в настройке autoapi_dir.См. Значение конфигурации autoapi_dirs для autoapi.

...