Sphinx將python代碼注釋生成文檔


安裝

使用pip進行安裝:

pip install sphinx

初始化

進入你代碼所在的目錄,輸入:

sphinx-quickstart

下圖:PRD是代碼所在目錄,生成的文檔保存目錄設成doc 
這里寫圖片描述

下圖:設置項目名稱與作者,項目名稱之后會作為標題顯示在文檔首頁 
這里寫圖片描述

下圖:基本一路默認 
這里寫圖片描述

下圖:到此,生成doc文件夾 
這里寫圖片描述

配置修改

進入此文件夾找到conf.py文件,打開編輯,將下面幾行代碼(第19-21行)取消注釋:

並修改代碼為:

生成 rst

到代碼目錄,執行以下命令,會生成對應 python 文件名的 rst 文件

這里寫圖片描述

生成 html

進入doc文件夾,執行make指令,生成html文檔頁 
這里寫圖片描述

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM