1

我正在尝试使用带有autodoc和拿破仑扩展的Sphinx为我的 Django 项目自动生成文档。

使用sphinx-quickstart我创建了以下结构：

MyDjangoProject
├── __init__.py
├── config
│   ├── __init__.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── docs
│   ├── Makefile
│   ├── build
│   └── source
│       ├── _static
│       ├── _templates
│       ├── conf.py
│       └── index.rst
├── myfirstapp
│   ├── __init__.py
│   ├── models.py
│   └── views.py
├── mysecondapp
│   ├── __init__.py
│   ├── models.py
│   └── views.py

...

我已经定制docs/source/conf.py以反映我的项目结构。

import os
import sys

proj_folder = os.path.realpath(
    os.path.join(os.path.dirname(__file__), '../..'))

sys.path.append(proj_folder)

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings')

import django
django.setup()

extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.napoleon', 'sphinx.ext.viewcode']

# The rest of the default configuration...

然后我转到项目的根目录并运行sphinx-apidoc -f -o docs/source .. 这会将.rst每个模块的文件添加到docs/source.

最后我去MyDjangoProject跑步make html。这失败，每个模块都有一个错误说

Traceback (most recent call last):
  File "/Users/Oskar/git/MyDjangoProject/venv/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 551, in import_object
    __import__(self.modname)
ImportError: No module named MyDjangoProject.myfirstapp

我究竟做错了什么？

4

1 回答 1

2

由于您已添加MyDjangoProject到 python 路径，因此您应该导入myfirstappasmyfirstapp而不是MyDjangoProject.myfirstapp.

于 2017-01-25T14:21:18.547 回答