这篇文章主要介绍了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
再次尝试，终于成功了…
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。
免责声明：本站资源来自互联网收集,仅供用于学习和交流,请遵循相关法律法规,本站一切资源不代表本站立场,如有侵权、后门、不妥请联系本站删除！
3月27日消息，苹果宣布2024年全球开发者大会（WWDC）将于6月10日至6月14日举行，巧合的是，这次大会与端午假期重合。
苹果官方表示：
在线参加 Apple 每年规模最大的开发者盛会。亲眼见证 Apple 最新平台、技术和工具的发布。了解如何创建和改进你的 App 和游戏。与 Apple 设计师和工程师互动交流，与全球开发者社区建立联系。以上活动均免费在线举行。
探索各种新的工具、框架和功能，助力你打造出理想的 App 和游戏。通过视频讲座学习新技能，与 Apple 专家进行一对一会面，以推进你的项目，完善你的构思。
Swift Student Challenge 旨在支持和鼓舞下一代开发者、创作者和企业家。太平洋时间 3 月 28 日，我们将公布今年的获奖者名单。获奖者将有资格参加在 Apple Park 举办的特别活动。我们还会选出 50 名杰出获胜者，他们将受邀前往库比提诺，获得为期三天的非凡体验，包括参加 Apple Park 的特别活动。
RTX 5090要首发 性能要翻倍！三星展示GDDR7显存
三星在GTC上展示了专为下一代游戏GPU设计的GDDR7内存。
首次推出的GDDR7内存模块密度为16GB，每个模块容量为2GB。其速度预设为32 Gbps（PAM3），但也可以降至28 Gbps，以提高产量和初始阶段的整体性能和成本效益。
据三星表示，GDDR7内存的能效将提高20%，同时工作电压仅为1.1V，低于标准的1.2V。通过采用更新的封装材料和优化的电路设计，使得在高速运行时的发热量降低，GDDR7的热阻比GDDR6降低了70%。