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 相关文章推荐
Pycharm学习教程(5) Python快捷键相关设置
May 03 Python
老生常谈Python startswith()函数与endswith函数
Sep 08 Python
Python3 模块、包调用&路径详解
Oct 25 Python
Python 网络爬虫--关于简单的模拟登录实例讲解
Jun 01 Python
python人民币小写转大写辅助工具
Jun 20 Python
对python中Librosa的mfcc步骤详解
Jan 09 Python
Python pycharm 同时加载多个项目的方法
Jan 17 Python
解决pycharm的Python console不能调试当前程序的问题
Jan 20 Python
Python2 Selenium元素定位的实现(8种)
Feb 25 Python
python实现从本地摄像头和网络摄像头截取图片功能
Jul 11 Python
python GUI库图形界面开发之PyQt5浏览器控件QWebEngineView详细使用方法
Feb 26 Python
如何Tkinter模块编写Python图形界面
Oct 14 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 $_ENV为空的原因分析
2009/06/01 PHP
PHP学习笔记之一
2011/01/17 PHP
php程序的国际化实现方法(利用gettext)
2011/08/14 PHP
深入探讨<br />和 \r\n两者有什么区别??
2013/06/05 PHP
分享一段php获取linux服务器状态的代码
2014/05/27 PHP
在WordPress中获取数据库字段内容和添加主题设置菜单
2016/01/11 PHP
php微信公众平台开发(四)回复功能开发
2016/12/06 PHP
权威JavaScript 中的内存泄露模式
2007/08/13 Javascript
前台js对象在后台转化java对象的问题探讨
2013/12/20 Javascript
JQuery1.8 判断元素是否绑定事件的方法
2014/07/10 Javascript
js的各种排序算法实现(总结)
2016/07/23 Javascript
深入浅出 jQuery中的事件机制
2016/08/23 Javascript
Javascript函数中的arguments.callee用法实例分析
2016/09/16 Javascript
jQuery学习笔记之入门
2016/12/14 Javascript
鼠标拖动改变DIV等网页元素的大小的实现方法
2017/07/06 Javascript
详解React-Native解决键盘遮挡问题(Keyboard遮挡问题)
2017/07/13 Javascript
webpack构建换肤功能的思路详解
2017/11/27 Javascript
vue实现微信分享朋友圈,发送朋友的示例讲解
2018/02/10 Javascript
微信小程序methods中定义的方法互相调用的实例代码
2018/08/07 Javascript
微信小程序按顺序同步执行的两种方式
2019/12/20 Javascript
[01:18:31]DOTA2-DPC中国联赛定级赛 LBZS vs Magma BO3第一场 1月10日
2021/03/11 DOTA
Python递归实现汉诺塔算法示例
2018/03/19 Python
Django框架ORM数据库操作实例详解
2019/11/07 Python
Python面向对象之多态原理与用法案例分析
2019/12/30 Python
Python常用库Numpy进行矩阵运算详解
2020/07/21 Python
CSS3制作Dropdown下拉菜单的方法
2015/07/18 HTML / CSS
卡西欧G-SHOCK英国官网: 防水防震手表
2018/01/08 全球购物
个人工作表现评语
2014/04/30 职场文书
国贸专业求职信
2014/06/28 职场文书
关于保护环境的建议书
2014/08/26 职场文书
学校总务处领导干部个人对照检查材料思想汇报
2014/10/06 职场文书
工作迟到检讨书范文
2015/05/06 职场文书
个人业务学习心得体会
2016/01/25 职场文书
Django+Celery实现定时任务的示例
2021/06/23 Python
详解Flutter和Dart取消Future的三种方法
2022/04/07 Java/Android
Golang数据类型和相互转换
2022/04/12 Golang