使用Sphinx Autodoc時模擬內部模塊

Question

我的python包有一個名爲settings.py的模塊，它查找settings.ini文件，如果找不到，則引發異常。

我的軟件包工作正常，但是當我嘗試使用Sphinx Autodoc時，它失敗了，因爲它無法找到設置文件。

我有什麼選擇來解決這個問題？我能想到的是

1. 把一個settings.ini文件放在其中一個Sphinx目錄中，以便它可以被讀取。
2. 如果可能，以某種方式模擬內部設置模塊。該設置模塊是不重要的，所以我不關心，如果沒有對發售者

試圖生成在需要外部文件包獅身人面像文檔時有沒有人遇到了類似的問題還沒有文檔，並若然你的解決方案是？

Answer 1

金字塔有一個命令行腳本pserve，它加載了一個.ini設置文件。

爲了證明這個腳本，我們使用autoprogram如下：

.. autoprogram:: pyramid.scripts.pserve:PServeCommand.parser 
    :prog: pserve 

，並在您conf.py：

extensions = [ 
... 
    'sphinxcontrib.autoprogram', 
... 
] 

它需要在你的腳本使用argparse。