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的print用法示例
Feb 11 Python
在Python中使用cookielib和urllib2配合PyQuery抓取网页信息
Apr 25 Python
对python中raw_input()和input()的用法详解
Apr 22 Python
快速解决pandas.read_csv()乱码的问题
Jun 15 Python
符合语言习惯的 Python 优雅编程技巧【推荐】
Sep 25 Python
dataframe 按条件替换某一列中的值方法
Jan 29 Python
python使用BeautifulSoup与正则表达式爬取时光网不同地区top100电影并对比
Apr 15 Python
python 应用之Pycharm 新建模板默认添加编码格式-作者-时间等信息【推荐】
Jun 17 Python
PyQt+socket实现远程操作服务器的方法示例
Aug 22 Python
python collections模块的使用
Oct 16 Python
Python中使用aiohttp模拟服务器出现错误问题及解决方法
Oct 31 Python
利用pipenv和pyenv管理多个相互独立的Python虚拟开发环境
Nov 01 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的String类代码
2010/04/20 PHP
PHP中使用crypt()实现用户身份验证的代码
2012/09/05 PHP
查找mysql字段中固定字符串并替换的几个方法
2012/09/23 PHP
php json_encode值中大括号与花括号区别
2013/09/30 PHP
php resizeimage 部分jpg文件 生成缩略图失败的原因分析及解决办法
2016/03/23 PHP
深入理解PHP之OpCode原理详解
2016/06/01 PHP
php使用SAE原生Mail类实现各种类型邮件发送的方法
2016/10/10 PHP
Referer原理与图片防盗链实现方法详解
2019/07/03 PHP
JavaScript中两个感叹号的作用说明
2011/12/28 Javascript
Javascript模块化编程(一)模块的写法最佳实践
2013/01/17 Javascript
jQuery增加与删除table列的方法
2016/03/01 Javascript
js实现拖拽功能
2017/03/01 Javascript
xmlplus组件设计系列之文本框(TextBox)(3)
2017/05/03 Javascript
jQuery插件FusionCharts绘制的2D双柱状图效果示例【附demo源码】
2017/05/13 jQuery
不得不看之JavaScript构造函数及new运算符
2017/08/21 Javascript
vue中阻止click事件冒泡,防止触发另一个事件的方法
2018/02/08 Javascript
[01:07:21]NAVI vs VG Supermajor 败者组 BO3 第二场 6.5
2018/06/06 DOTA
[07:57]2018DOTA2国际邀请赛寻真——PSG.LGD凤凰浴火
2018/08/12 DOTA
python根据开头和结尾字符串获取中间字符串的方法
2015/03/26 Python
在Python中操作字符串之replace()方法的使用
2015/05/19 Python
Python每天必学之bytes字节
2016/01/28 Python
Django 跨域请求处理的示例代码
2018/05/02 Python
详解Python循环作用域与闭包
2019/03/21 Python
python 两个数据库postgresql对比
2019/10/21 Python
利用Python的turtle库绘制玫瑰教程
2019/11/23 Python
django3.02模板中的超链接配置实例代码
2020/02/04 Python
面向新手解析python Beautiful Soup基本用法
2020/07/11 Python
Python如何批量生成和调用变量
2020/11/21 Python
英国音乐设备和乐器商店:Gear4music
2017/10/16 全球购物
新加坡最早生产电动滑板车的制造商之一:FunsToTheFore
2020/09/08 全球购物
电气专业推荐信范文
2013/11/18 职场文书
八年级英语教学反思
2014/01/09 职场文书
党委工作总结2015
2015/04/27 职场文书
Mysql服务添加 iptables防火墙策略的方案
2021/04/29 MySQL
python 如何执行控制台命令与操作剪切板
2021/05/20 Python