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 应该可以工作)

Answer 2

正如人们所说，你应该这样做：

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

有时还需要修改您的 conf.py 以导入一些源模块。 以及向类添加一些文档以加载其方法文档（仅适用于私有类，但我一直坚持这样做）。