python - 我怎样才能让 'autodoc' 工作？

Question

当我制作htmlthis little project的Sphinx文档时我得到:

$ make html
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v1.1.3
loading pickled environment... done
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] index                                                                                                                      
/home/moose/Downloads/lumix_map_tool/doc/index.rst:16: WARNING: don't know which module to import for autodocumenting u'maptool' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index                                                                                                                       
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 1 warning.

我的目录结构是

.
├── doc (automaticall generated by sphinx-quickstart)
├── LICENSE
├── maptool.log
├── maptool.py
└── README.md

我已将 sys.path.insert(0, os.path.abspath('/home/moose/Downloads/lumix_map_tool/')) 添加到 doc/conf.py .

为什么Sphinx找不到maptool.py？

Answer 1

您有一个名为 maptool 的模块，但在 GitHub 项目的 index.rst 中它显示:

.. autoclass:: maptool
   :members:
   :undoc-members:

如果将 autoclass 更改为 automodule，它应该可以工作。