依賴另一個擴充功能

有時您的擴充功能會依賴另一個 Sphinx 擴充功能的功能。大多數 Sphinx 擴充功能會在專案的 conf.py 檔案中啟用,但作為擴充功能開發人員,您無法使用此檔案。

為了確保另一個擴充功能作為您自身擴充功能的一部分被啟用,請使用 sphinx.application.Sphinx.setup_extension() 方法。這將在執行時啟用另一個擴充功能,確保您可以存取其功能。

例如,以下程式碼啟用了 sphinx.ext.autodoc 擴充功能

def setup(app):
    app.setup_extension('sphinx.ext.autodoc')

注意

由於您的擴充功能將依賴另一個擴充功能,請務必將其作為您擴充功能安裝需求的一部分包含在內。