斯芬克斯autodoc没有导入任何东西？

Question

我试图使用sphinx（与autodoc和numpydoc）来记录我的模块，但是在基本设置之后，运行make html只生成基本的html，不包含docstring。我运行的是python3.3，项目结构概要如下：

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

__init__.py是空的，并且在我添加的docs/source目录的conf.py中

在docs目录中运行make html将得到以下输出：

^{pr2}$

那么，我做错什么了？在

Answer 1

你在docs/source目录下运行了sphinxapidoc吗？这将生成用于生成html的.rst文件。从man sphinx-apidoc

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

您需要（至少）包括outputdir（在.rst文件的位置，./should可以工作）和sourcedir，它们应该指向您的包（看起来像.././src/kineticmulti应该可以工作）

Answer 2

正如人们所说，你应该：

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

有时修改您的配置文件导入一些源模块也是必要的。以及向类中添加一些文档以加载其方法docs（只能对private classed有效，但我在这方面做得不好）。在