这篇文章主要介绍了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-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 or sphinx-build -b html ./doc/source ./doc/build
发现两个命令都可以正常生成文档的模版,但并没有生成注释;即有生成的html,但没有代码的注释/API文档
尝试解决
开始以往是版本不一致,就重新建了virtualenv,还是不行;
使用了一个docker镜像,重试,结果是同样的错误
尝试看非官方的教程,发现还需要更改 source 下的 index.rst;
例如我们的代码文件是 run.py ,需要把他加到 index.rst中,如下(run就是模块名称):
API === .. automodule:: run :members:
再次执行,发现还有错,只不过提示不一样了:提示
Unknown directive type “automodule” or “autoclass”
谷歌之,发现还要改一个配置的地方;位于 conf.py 里,增加一个扩展……如下:
extensions = [ 'sphinx.ext.autodoc' ]
此处参考了 https://stackoverflow.com/questions/13516404/sphinx-error-unknown-directive-type-automodule-or-autoclass
再次尝试,终于成功了…
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
RTX 5090要首发 性能要翻倍!三星展示GDDR7显存
三星在GTC上展示了专为下一代游戏GPU设计的GDDR7内存。
首次推出的GDDR7内存模块密度为16GB,每个模块容量为2GB。其速度预设为32 Gbps(PAM3),但也可以降至28 Gbps,以提高产量和初始阶段的整体性能和成本效益。
据三星表示,GDDR7内存的能效将提高20%,同时工作电压仅为1.1V,低于标准的1.2V。通过采用更新的封装材料和优化的电路设计,使得在高速运行时的发热量降低,GDDR7的热阻比GDDR6降低了70%。
更新动态
- 雨林唱片《赏》新曲+精选集SACD版[ISO][2.3G]
- 罗大佑与OK男女合唱团.1995-再会吧!素兰【音乐工厂】【WAV+CUE】
- 草蜢.1993-宝贝对不起(国)【宝丽金】【WAV+CUE】
- 杨培安.2009-抒·情(EP)【擎天娱乐】【WAV+CUE】
- 周慧敏《EndlessDream》[WAV+CUE]
- 彭芳《纯色角3》2007[WAV+CUE]
- 江志丰2008-今生为你[豪记][WAV+CUE]
- 罗大佑1994《恋曲2000》音乐工厂[WAV+CUE][1G]
- 群星《一首歌一个故事》赵英俊某些作品重唱企划[FLAC分轨][1G]
- 群星《网易云英文歌曲播放量TOP100》[MP3][1G]
- 方大同.2024-梦想家TheDreamer【赋音乐】【FLAC分轨】
- 李慧珍.2007-爱死了【华谊兄弟】【WAV+CUE】
- 王大文.2019-国际太空站【环球】【FLAC分轨】
- 群星《2022超好听的十倍音质网络歌曲(163)》U盘音乐[WAV分轨][1.1G]
- 童丽《啼笑姻缘》头版限量编号24K金碟[低速原抓WAV+CUE][1.1G]