這篇文章主要介紹了Python Sphinx使用實(shí)例及問(wèn)題解決,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下

描述

使用 pip 安裝sphinx后，按照教程建立了一個(gè)新的py文件，如下

# run.pydef 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 osimport syssys.path.insert(0, os.path.abspath('../..'))

然后在 doc 下執(zhí)行下面命令：

make htmlorsphinx-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']

此處參考了 https://stackoverflow.com/questions/13516404/sphinx-error-unknown-directive-type-automodule-or-autoclass

再次嘗試，終于成功了…

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持武林網(wǎng)之家。