python - Sphinx autodoc 没有导入任何东西？

Question

我正在尝试使用 sphinx(结合 autodoc 和 numpydoc)来记录我的模块，但是在基本设置之后，运行 make html 只生成基本的 html，不包含文档字符串。我运行的是Python 3.3，项目结构大纲如下:

Kineticlib
|--docs
|  |--build
|  |--source
|  |  |--conf.py
|--src
|  |--kineticmulti
|  |  |--__init__.py
|  |  |--file1.py
|  |  |--file2.py
|--setup.py

__init__.py 是空的，在 docs/source 目录的 conf.py 中我添加了 sys. path.insert(0, os.path.abspath('../..'))

在 docs 目录中运行 make html 会得到以下输出:

sphinx-build -b html -d build/doctrees   source build/html
Running Sphinx v1.2.2
loading pickled environment... done
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
no targets are out of date.

Build finished. The HTML pages are in build/html.

那么，我做错了什么？

Answer 1

您是否在 docs/source 目录中运行了 sphinx-apidoc？这将生成用于制作 html 的 .rst 文件。来自 man sphinx-apidoc,

sphinx-apidoc [options] -o <outputdir> <sourcedir> [pathnames ...]

您需要(至少)包含 outputdir(.rst 文件所在的位置，./应该可以工作)和 sourcedir 应该指向到你的包裹(看起来 ../../src/kineticmulti 应该工作)