Python Sphinx使用踩坑記錄

2021-10-09 13:59:10 字數 1353 閱讀 9291

描述

使用 pip 安裝sphinx後，按照教程建立了乙個新的py檔案，如下

# run.py


defrun


(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


orsphinx-build -b html .


/doc/source .


/doc/build
發現兩個命令都可以正常生成文件的模版，但並沒有生成注釋；即有生成的html，但沒有**的注釋/api文件

嘗試解決

開始以往是版本不一致，就重新建了virtualenv，還是不行；

使用了乙個docker映象，重試，結果是同樣的錯誤

2嘗試看非官方的教程，發現還需要更改 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使用踩坑記錄

使用 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...

Python Sphinx使用例項及問題解決

描述 使用 pip 安裝sphinx後，按照教程建立了乙個新的py檔案，如下 run.py def run name this is how we run param name name of people who runs print name,hytpocbthis 程式設計客棧running ...

axios使用踩坑

1 params和data 1 params params一般用於和url拼接，用於get請求，比如 axios.get user?id 12345 就等價於 axios.get user 2 data data請求是新增在請求體裡的，也就是body中，用於post請求。2 請求頭相關 1 post...