溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
這篇文章主要為大家展示了“Python中Sphinx怎么用”，內容簡而易懂，條理清晰，希望能夠幫助大家解決疑惑，下面讓小編帶領大家一起研究并學習一下“Python中Sphinx怎么用”這篇文章吧。
描述
使用 pip 安裝sphinx后，按照教程建立了一個新的py文件，如下
# run.py def run(name): """ this is how we run :param name name of people who runs """ print(name, 'is running')
隨后新建一個目錄，使用 sphinx-quickstart 新建了sphinx環境，此時目錄結構如下：
- doc - Makefile - build/ - make.bat - source/ - run.py
此時進入 source目錄，在conf.py 中添加文件路徑，如下：
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))然后在 doc 下執行下面命令：
make html or sphinx-build -b html ./doc/source ./doc/build
發現兩個命令都可以正常生成文檔的模版，但并沒有生成注釋；即有生成的html，但沒有代碼的注釋/API文檔
嘗試解決
開始以往是版本不一致，就重新建了virtualenv，還是不行；
使用了一個docker鏡像，重試，結果是同樣的錯誤
嘗試看非官方的教程，發現還需要更改 source 下的 index.rst；
例如我們的代碼文件是 run.py ，需要把他加到 index.rst中，如下（run就是模塊名稱）：
API === .. automodule:: run :members:
再次執行，發現還有錯，只不過提示不一樣了：提示
Unknown directive type “automodule” or “autoclass”
谷歌之，發現還要改一個配置的地方；位于 conf.py 里，增加一個擴展……如下：
extensions = [ 'sphinx.ext.autodoc' ]
以上是“Python中Sphinx怎么用”這篇文章的所有內容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內容對大家有所幫助，如果還想學習更多知識，歡迎關注億速云行業資訊頻道！
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
