更改sys.path以阅读文档

Question

我正在用狮身人面像在本地记录我的金字塔项目。 在本地autodoc可以正常工作，并且文档看起来像我想要的样子。

但是，如果我正在阅读文档，则每次使用autodoc功能时都会遇到以下错误：

/home/docs/checkouts/readthedocs.org/user_builds/buchungssystem/checkouts/latest/docs/source/02database/02models.rst:8: WARNING: autodoc: failed to import class u'Person' from module u'buchungssystem.models.person'; the following exception was raised: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/buchungssystem/envs/latest/local/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 385, in import_object __import__(self.modname) ImportError: No module named buchungssystem.models.person

我的项目的结构如下：

project
->code
  ->models
  ->scripts
  ->...
  ->__init__.py
  ->...
->docs
  ->conf.py
  ->documentation
->setup.py

我认为我的sys.path配置不正确。 尝试了很多之后，我回到了sys.path.insert(0, os.path.abspath('.'))

Answer 1

在您的conf.py试试这个

sys.path.insert(0, os.path.join(os.path.dirname((os.path.abspath('.')), 'code', 'models')

因为它需要通向Person类的路径，并且该类是层次结构中的上一步，因此您可以拉出该类的路径。