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列表操作之extend和append的区别实例分析
Jul 28 Python
基于Python的关键字监控及告警
Jul 06 Python
python merge、concat合并数据集的实例讲解
Apr 12 Python
浅析python3中的os.path.dirname(__file__)的使用
Aug 30 Python
Python操作多维数组输出和矩阵运算示例
Nov 28 Python
Django生成PDF文档显示网页上以及PDF中文显示乱码的解决方法
Dec 17 Python
python 已知三条边求三角形的角度案例
Apr 12 Python
降低python版本的操作方法
Sep 11 Python
python爬虫构建代理ip池抓取数据库的示例代码
Sep 22 Python
Python实现淘宝秒杀功能的示例代码
Jan 19 Python
python 爬取华为应用市场评论
May 29 Python
python中字符串String及其常见操作指南(方法、函数)
Apr 06 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实现合并discuz用户
2015/08/05 PHP
thinkPHP引入类的方法详解
2016/12/08 PHP
php解析mht文件转换成html的实例
2017/03/13 PHP
THINKPHP截取中文字符串函数实例代码
2017/03/20 PHP
yii2实现Ueditor百度编辑器的示例代码
2018/11/02 PHP
php框架CI(codeigniter)自动加载与自主创建对象操作实例分析
2020/06/06 PHP
passwordStrength 基于jquery的密码强度检测代码使用介绍
2011/10/08 Javascript
javascript修改表格背景色实例代码分享
2013/12/10 Javascript
jquery ajax 局部无刷新更新数据的实现案例
2014/02/08 Javascript
js中window.open打开一个新的页面
2014/08/10 Javascript
jQuery判断浏览器并动态调整select宽度的方法
2016/03/02 Javascript
vue-cli的webpack模板项目配置文件分析
2017/04/01 Javascript
vue watch自动检测数据变化实时渲染的方法
2018/01/16 Javascript
解决vue中虚拟dom,无法实时更新的问题
2018/09/15 Javascript
详解angularjs4部署文件过大解决过程
2018/12/05 Javascript
微信小程序扫描二维码获取信息实例详解
2019/05/07 Javascript
vue-cli配置flexible过程详解
2019/07/04 Javascript
Javascript Web Worker使用过程解析
2020/03/16 Javascript
javascript实现前端分页效果
2020/06/24 Javascript
JavaScript async/await原理及实例解析
2020/12/02 Javascript
Python实现给文件添加内容及得到文件信息的方法
2015/05/28 Python
使用Python编写基于DHT协议的BT资源爬虫
2016/03/19 Python
Python实现的简单模板引擎功能示例
2017/09/02 Python
python-pyinstaller、打包后获取路径的实例
2019/06/10 Python
python处理RSTP视频流过程解析
2020/01/11 Python
浅谈keras通过model.fit_generator训练模型(节省内存)
2020/06/17 Python
python反爬虫方法的优缺点分析
2020/11/25 Python
python实现不同数据库间数据同步功能
2021/02/25 Python
CSS3动画:5种预载动画效果实例
2017/04/05 HTML / CSS
数据库面试要点基本概念
2013/10/31 面试题
文秘人员工作职责
2014/01/31 职场文书
军校大学生个人的自我评价
2014/02/17 职场文书
单位绩效考核方案
2014/05/11 职场文书
2015年机关纠风工作总结
2015/05/15 职场文书
用电申请报告范文
2015/05/18 职场文书
采购部2015年度工作总结
2015/07/24 职场文书