sphinx-apidoc不包含路径中的根目录

时间:2016-12-25 17:51:02

标签: python python-sphinx

假设我有一个文件夹结构

A\__init__.py
A\math\__init__.py
A\math\others.py
A\stats\__init__.py
A\stats\andthese.py

我的python路径中有A,所以通常我会import math.others,但import A.math.others会失败。

现在在文件夹A中,我做

sphinx-apidoc -o ./documentation ./ --full --force

生成配置文件,例如

A\documentation\A.rst
A\documentation\A.math.rst
A\documentation\A.math.others.rst

然后在A\documentation我做make html。这将失败,因为它无法导入A.math.others(我不想让A的父文件夹成为python路径。)

如何在没有导入路径中包含根目录的情况下使sphinx-apidoc生成配置文件?

1 个答案:

答案 0 :(得分:1)

自己想出来。

在生成的A\documentation\conf.py中,取消注释第18-20行

import os
import sys
sys.path.insert(0, u'D:/A')

将最后一行修改为

sys.path.insert(0, u'D:')

现在所有导入都可以使用。