Python Sphinx使用实例及问题解决


Posted in Python onJanuary 17, 2020

这篇文章主要介绍了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

再次尝试,终于成功了…

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
python中的闭包用法实例详解
May 05 Python
python通过openpyxl生成Excel文件的方法
May 12 Python
python实现周期方波信号频谱图
Jul 21 Python
python的常用模块之collections模块详解
Dec 06 Python
python 利用pandas将arff文件转csv文件的方法
Feb 12 Python
python logging模块书写日志以及日志分割详解
Jul 22 Python
python3 requests库文件上传与下载实现详解
Aug 22 Python
python实现操作文件(文件夹)
Oct 31 Python
Pytorch 实现数据集自定义读取
Jan 18 Python
浅谈ROC曲线的最佳阈值如何选取
Feb 28 Python
Python捕获、播放和保存摄像头视频并提高视频清晰度和对比度
Apr 14 Python
Python Matplotlib绘制动画的代码详解
May 30 Python
通过实例了解Python str()和repr()的区别
Jan 17 #Python
python无序链表删除重复项的方法
Jan 17 #Python
Python实现投影法分割图像示例(一)
Jan 17 #Python
np.dot()函数的用法详解
Jan 17 #Python
python使用numpy实现直方图反向投影示例
Jan 17 #Python
对python中 math模块下 atan 和 atan2的区别详解
Jan 17 #Python
python 计算方位角实例(根据两点的坐标计算)
Jan 17 #Python
You might like
php你的验证码安全码?
2007/01/02 PHP
php获取地址栏信息的代码
2008/10/08 PHP
php重定向的三种方法分享
2012/02/22 PHP
php运行时动态创建函数的方法
2015/03/16 PHP
PHP 生成微信红包代码简单
2016/03/25 PHP
php格式化时间戳
2016/12/17 PHP
两个DIV等高的JS的实现代码
2007/12/23 Javascript
番茄的表单验证类代码修改版
2008/07/18 Javascript
jQuery lazyload 的重复加载错误以及修复方法
2010/11/19 Javascript
一个网马的tips实现分析
2010/11/28 Javascript
jQuery源码分析-05异步队列 Deferred 使用介绍
2011/11/14 Javascript
通过隐藏iframe实现文件下载的js方法介绍
2014/02/26 Javascript
js实现Form栏显示全格式时间时钟效果代码
2015/08/19 Javascript
jQuery实现TAB风格的全国省份城市滑动切换效果代码
2015/08/24 Javascript
3kb jQuery代码搞定各种树形选择的实现方法
2016/06/10 Javascript
JS获取浮动(float)元素的style.left值为空的快速解决办法
2017/02/19 Javascript
Angularjs中数据绑定的实例详解
2017/08/25 Javascript
jQuery中ajax获取数据赋值给页面的实例
2017/12/31 jQuery
微信小程序progress组件使用详解
2018/01/31 Javascript
每周一练 之 数据结构与算法(Stack)
2019/04/16 Javascript
jQuery实现容器间的元素拖拽功能
2020/12/01 jQuery
python创建只读属性对象的方法(ReadOnlyObject)
2013/02/10 Python
Python def函数的定义、使用及参数传递实现代码
2014/08/10 Python
安装Python的web.py框架并从hello world开始编程
2015/04/25 Python
Python获取系统默认字符编码的方法
2015/06/04 Python
Python黑帽编程 3.4 跨越VLAN详解
2016/09/28 Python
Django中如何防范CSRF跨站点请求伪造攻击的实现
2019/04/28 Python
Python socket模块方法实现详解
2019/11/05 Python
浅析Python __name__ 是什么
2020/07/07 Python
Python制作运行进度条的实现效果(代码运行不无聊)
2021/02/24 Python
5 个强大的HTML5 API 函数推荐
2014/11/19 HTML / CSS
玩具反斗城葡萄牙官方商城:Toys"R"Us葡萄牙
2016/10/21 全球购物
啤酒销售实习自我鉴定
2013/09/24 职场文书
寄语是什么意思
2014/04/10 职场文书
社区爱国卫生月活动总结
2014/06/30 职场文书
Java数组详细介绍及相关工具类
2022/04/14 Java/Android