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)有生成注釋；即有生成的html，但沒(méi)有代碼的注釋/API文檔
嘗試解決
開(kāi)始以往是版本不一致，就重新建了virtualenv，還是不行；
使用了一個(gè)docker鏡像，重試，結(jié)果是同樣的錯(cuò)誤
嘗試看非官方的教程，發(fā)現(xiàn)還需要更改 source 下的 index.rst；
例如我們的代碼文件是 run.py ，需要把他加到 index.rst中，如下（run就是模塊名稱）：
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)文章
詳解Python如何獲取視頻文件的大小和時(shí)長(zhǎng)
這篇文章主要為大家詳細(xì)介紹了Python如何實(shí)現(xiàn)獲取視頻文件的大小和時(shí)長(zhǎng)，文中的示例代碼講解詳細(xì)，感興趣的小伙伴可以跟隨小編一起了解一下2023-03-03
Django在pycharm下修改默認(rèn)啟動(dòng)端口的方法
今天小編就為大家分享一篇Django在pycharm下修改默認(rèn)啟動(dòng)端口的方法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2019-07-07
python for循環(huán)輸入一個(gè)矩陣的實(shí)例
今天小編就為大家分享一篇python for循環(huán)輸入一個(gè)矩陣的實(shí)例，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2018-11-11
淺談python for循環(huán)的巧妙運(yùn)用(迭代、列表生成式)
下面小編就為大家?guī)?lái)一篇淺談python for循環(huán)的巧妙運(yùn)用(迭代、列表生成式)。2017-09-09
Python隨機(jī)讀取文件實(shí)現(xiàn)實(shí)例
這篇文章主要介紹了Python隨機(jī)讀取文件的相關(guān)資料,需要的朋友可以參考下2017-05-05
非常全面的Python常見(jiàn)基礎(chǔ)面試題及答案
Python是目前編程領(lǐng)域最受歡迎的語(yǔ)言,Python可用于許多領(lǐng)域,Web應(yīng)用程序開(kāi)發(fā),自動(dòng)化,數(shù)學(xué)建模,大數(shù)據(jù)應(yīng)用程序等等,這篇文章主要給大家介紹了關(guān)于Python常見(jiàn)基礎(chǔ)面試題及答案的相關(guān)資料,需要的朋友可以參考下2021-09-09
python 設(shè)置文件編碼格式的實(shí)現(xiàn)方法
下面小編就為大家分享一篇python 設(shè)置文件編碼格式的實(shí)現(xiàn)方法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2017-12-12
下面小編就為大家分享一篇Numpy掩碼式數(shù)組詳解，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2018-04-04
Python簡(jiǎn)單實(shí)現(xiàn)控制電腦的方法
這篇文章主要介紹了Python簡(jiǎn)單實(shí)現(xiàn)控制電腦的方法,涉及Python基于os及win32api等模塊調(diào)用系統(tǒng)命令操作電腦的相關(guān)實(shí)現(xiàn)技巧,需要的朋友可以參考下2018-01-01
Python實(shí)現(xiàn)敲擊木魚(yú)積累功德小項(xiàng)目
最近大家都很流行用手機(jī)敲擊電子木魚(yú)積累功德，這在很多短視頻中也常常見(jiàn)到。本文將用Python實(shí)現(xiàn)這一效果，感興趣的小伙伴可以了解一下2022-11-11