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学习笔记(一)(基础入门之环境搭建)
Jun 05 Python
python中使用urllib2伪造HTTP报头的2个方法
Jul 07 Python
Python import自定义模块方法
Feb 12 Python
举例讲解Python中的list列表数据结构用法
Mar 12 Python
Android模拟器无法启动,报错:Cannot set up guest memory ‘android_arm’ Invalid argument的解决方法
Jul 01 Python
详解Python计算机视觉 图像扭曲(仿射扭曲)
Mar 27 Python
Django model select的多种用法详解
Jul 16 Python
python数据预处理之数据标准化的几种处理方式
Jul 17 Python
django中嵌套的try-except实例
May 21 Python
Python 3.10 的首个 PEP 诞生,内置类型 zip() 迎来新特性(推荐)
Jul 03 Python
Python Selenium模块安装使用教程详解
Jul 09 Python
Python如何将模块打包并发布
Aug 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的MVC模式实现原理分析(一相简单的MVC框架范例)
2014/04/29 PHP
PHP的Socket通信之UDP通信实例
2015/07/02 PHP
js代码实现微博导航栏
2015/07/30 PHP
WordPress网站性能优化指南
2015/11/18 PHP
onpropertypchange
2006/07/01 Javascript
无刷新预览所选择的图片示例代码
2014/04/02 Javascript
详细解读JavaScript的跨浏览器事件处理
2015/08/12 Javascript
Javascript字符串拼接小技巧(推荐)
2016/06/02 Javascript
jQuery Easyui加载表格出错时在表格中间显示自定义的提示内容
2016/12/08 Javascript
使用ionic在首页新闻中应用到的跑马灯效果的实现方法
2017/02/13 Javascript
NodeJS处理Express中异步错误
2017/03/26 NodeJs
javascript 中Cookie读、写与删除操作
2017/03/29 Javascript
详解nodeJS之路径PATH模块
2017/05/31 NodeJs
vue 1.x 交互实现仿百度下拉列表示例
2017/10/21 Javascript
JS+HTML+CSS实现轮播效果
2017/11/28 Javascript
通过jquery的ajax请求本地的json文件方法
2018/08/08 jQuery
浅谈Vue.js路由管理器 Vue Router
2018/08/16 Javascript
浅谈laytpl 模板空值显示null的解决方法及简单的js表达式
2019/09/19 Javascript
vue element-ui实现input输入框金额数字添加千分位
2019/12/29 Javascript
[02:09]DOTA2辉夜杯 EHOME夺冠举杯现场
2015/12/28 DOTA
[48:54]VGJ.T vs infamous Supermajor小组赛D组败者组第一轮 BO3 第二场 6.3
2018/06/04 DOTA
python使用socket向客户端发送数据的方法
2015/04/29 Python
Python使用numpy模块创建数组操作示例
2018/06/20 Python
Python定义函数功能与用法实例详解
2019/04/08 Python
Python turtle库绘制菱形的3种方式小结
2019/11/23 Python
Pytorch上下采样函数--interpolate用法
2020/07/07 Python
html5 Canvas画图教程(3)—canvas出现1像素线条模糊不清的原因
2013/01/09 HTML / CSS
英国奢华护肤、美容和Spa品牌:Temple Spa
2019/11/02 全球购物
公务员职务工作的自我评价
2013/11/01 职场文书
影视艺术学院毕业生自荐信
2013/11/13 职场文书
女方婚礼新郎答谢词
2014/01/11 职场文书
会展策划与管理专业大学生职业生涯规划
2014/02/07 职场文书
企业办公室岗位职责
2014/03/12 职场文书
代领学位证书毕业证书委托书
2014/09/30 职场文书
高考作弊检讨书1500字
2015/02/16 职场文书
python字符串拼接.join()和拆分.split()详解
2021/11/23 Python