更改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類的路徑，並且該類是層次結構中的上一步，因此您可以拉出該類的路徑。