Python Sphinx使用实例及问题解决
更新时间：2020年01月17日 15:14:34 作者：wswang
这篇文章主要介绍了Python 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, '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'
]
再次尝试，终于成功了…
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。
相关文章
这篇文章主要介绍了scrapy实践之翻页爬取的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2021-01-01
wxPython是Python语言的一套优秀的GUI图形库。允许Python程序员很方便的创建完整的、功能键全的GUI用户界面。 wxPython是作为优秀的跨平台GUI库wxWidgets的Python封装和Python模块的方式提供给用户的2019-10-10
用的配置文件格式有ini、json、yaml等，下面简单给大家介绍下，Python如何读写这几种格式的文件，对Python读写ini、json、yaml配置文件相关知识感兴趣的朋友一起看看吧2021-07-07
python是现在开发的热潮，大家应该如何学习呢？许多人选择自学，还有人会选择去培训结构学习，那么好的培训机构的标准是什么样的呢？下面跟随脚本之家小编一起通过本文学习吧2018-05-05
这篇文章主要介绍了Python机器学习三大件之一numpy,文中有非常详细的代码示例,对正在学习python的小伙伴们有很好地帮助哟.需要的朋友可以参考下2021-05-05
在使用python运维与开发的过程中,经常需要打印显示各种信息,海量的信息堆砌在控制台中,就会导致各种信息都显示在一起,降低了重要信息的可读性,这时候如果能给重要的信息加上差异的字体颜色,那么就会更加显眼,所以本文给大家介绍了python输出带有颜色文字的三种方法2024-05-05
Python中多进程处理的Process和Pool的用法详解
在Python编程中,多进程是一种强大的并行处理技术,Python提供了两种主要的多进程处理方式：Process和Pool,本文将详细介绍这两种方式的使用,希望对大家有所帮助2024-02-02
这篇文章主要介绍了余弦相似性计算及python代码实现过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2019-09-09
这篇文章主要介绍了Python全局锁中如何合理运用多线程（多进程）,需要的朋友可以参考下2019-11-11
这篇文章主要介绍了Pandas数据分析固定时间点和时间差，文章未日澳主题展开详细的内容介绍，具有一定的参考价值，需要的小伙伴可以参考一下2022-08-08
最新评论