Python Sphinx使用實(shí)例及問(wèn)題解決
這篇文章主要介紹了Python Sphinx使用實(shí)例及問(wèn)題解決,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
描述
使用 pip 安裝sphinx后，按照教程建立了一個(gè)新的py文件，如下
# run.py def run(name): """ this is how we run :param name name of people who runs """ print(name, 'is running')
隨后新建一個(gè)目錄，使用 sphinx-quickstart 新建了sphinx環(huán)境，此時(shí)目錄結(jié)構(gòu)如下：
- doc - Makefile - build/ - make.bat - source/ - run.py
此時(shí)進(jìn)入 source目錄，在conf.py 中添加文件路徑，如下：
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
然后在 doc 下執(zhí)行下面命令：
make html or sphinx-build -b html ./doc/source ./doc/build
發(fā)現(xiàn)兩個(gè)命令都可以正常生成文檔的模版，但并沒(méi)有生成注釋?zhuān)患从猩傻膆tml，但沒(méi)有代碼的注釋/API文檔
嘗試解決
開(kāi)始以往是版本不一致，就重新建了virtualenv，還是不行；
使用了一個(gè)docker鏡像，重試，結(jié)果是同樣的錯(cuò)誤
嘗試看非官方的教程，發(fā)現(xiàn)還需要更改 source 下的 index.rst；
例如我們的代碼文件是 run.py ，需要把他加到 index.rst中，如下（run就是模塊名稱(chēng)）：
API === .. automodule:: run :members:
再次執(zhí)行，發(fā)現(xiàn)還有錯(cuò)，只不過(guò)提示不一樣了：提示
Unknown directive type “automodule” or “autoclass”
谷歌之，發(fā)現(xiàn)還要改一個(gè)配置的地方；位于 conf.py 里，增加一個(gè)擴(kuò)展……如下：
extensions = [
'sphinx.ext.autodoc'
]
再次嘗試，終于成功了…
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
scrapy實(shí)踐之翻頁(yè)爬取的實(shí)現(xiàn)
這篇文章主要介紹了scrapy實(shí)踐之翻頁(yè)爬取的實(shí)現(xiàn)，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-01-01
wxPython：python首選的GUI庫(kù)實(shí)例分享
wxPython是Python語(yǔ)言的一套優(yōu)秀的GUI圖形庫(kù)。允許Python程序員很方便的創(chuàng)建完整的、功能鍵全的GUI用戶(hù)界面。 wxPython是作為優(yōu)秀的跨平臺(tái)GUI庫(kù)wxWidgets的Python封裝和Python模塊的方式提供給用戶(hù)的2019-10-10
Python常用配置文件ini、json、yaml讀寫(xiě)總結(jié)
用的配置文件格式有ini、json、yaml等，下面簡(jiǎn)單給大家介紹下，Python如何讀寫(xiě)這幾種格式的文件，對(duì)Python讀寫(xiě)ini、json、yaml配置文件相關(guān)知識(shí)感興趣的朋友一起看看吧2021-07-07
好的Python培訓(xùn)機(jī)構(gòu)應(yīng)該具備哪些條件
python是現(xiàn)在開(kāi)發(fā)的熱潮，大家應(yīng)該如何學(xué)習(xí)呢？許多人選擇自學(xué)，還有人會(huì)選擇去培訓(xùn)結(jié)構(gòu)學(xué)習(xí)，那么好的培訓(xùn)機(jī)構(gòu)的標(biāo)準(zhǔn)是什么樣的呢？下面跟隨腳本之家小編一起通過(guò)本文學(xué)習(xí)吧2018-05-05
Python機(jī)器學(xué)習(xí)三大件之一numpy
這篇文章主要介紹了Python機(jī)器學(xué)習(xí)三大件之一numpy,文中有非常詳細(xì)的代碼示例,對(duì)正在學(xué)習(xí)python的小伙伴們有很好地幫助喲.需要的朋友可以參考下2021-05-05
在使用python運(yùn)維與開(kāi)發(fā)的過(guò)程中,經(jīng)常需要打印顯示各種信息,海量的信息堆砌在控制臺(tái)中,就會(huì)導(dǎo)致各種信息都顯示在一起,降低了重要信息的可讀性,這時(shí)候如果能給重要的信息加上差異的字體顏色,那么就會(huì)更加顯眼,所以本文給大家介紹了python輸出帶有顏色文字的三種方法2024-05-05
Python中多進(jìn)程處理的Process和Pool的用法詳解
在Python編程中,多進(jìn)程是一種強(qiáng)大的并行處理技術(shù),Python提供了兩種主要的多進(jìn)程處理方式：Process和Pool,本文將詳細(xì)介紹這兩種方式的使用,希望對(duì)大家有所幫助2024-02-02
余弦相似性計(jì)算及python代碼實(shí)現(xiàn)過(guò)程解析
這篇文章主要介紹了余弦相似性計(jì)算及python代碼實(shí)現(xiàn)過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-09-09
Python全局鎖中如何合理運(yùn)用多線程（多進(jìn)程）
這篇文章主要介紹了Python全局鎖中如何合理運(yùn)用多線程（多進(jìn)程）,需要的朋友可以參考下2019-11-11
Pandas數(shù)據(jù)分析固定時(shí)間點(diǎn)和時(shí)間差
這篇文章主要介紹了Pandas數(shù)據(jù)分析固定時(shí)間點(diǎn)和時(shí)間差，文章未日澳主題展開(kāi)詳細(xì)的內(nèi)容介紹，具有一定的參考價(jià)值，需要的小伙伴可以參考一下2022-08-08