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 相关文章推荐
PHP webshell检查工具 python实现代码
Sep 15 Python
Python牛刀小试密码爆破
Feb 03 Python
python正则表达式判断字符串是否是全部小写示例
Dec 25 Python
Python内置函数Type()函数一个有趣的用法
Feb 18 Python
在Python中使用pngquant压缩png图片的教程
Apr 09 Python
在Python dataframe中出生日期转化为年龄的实现方法
Oct 20 Python
Django 配置多站点多域名的实现步骤
May 17 Python
对pyqt5中QTabWidget的相关操作详解
Jun 21 Python
Python3.6+selenium2.53.6自动化测试_读取excel文件的方法
Sep 06 Python
使用Python的datetime库处理时间(RPA流程)
Nov 24 Python
MATLAB数学建模之画图汇总
Jul 16 Python
Python爬虫之Selenium设置元素等待的方法
Dec 04 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中魔术变量__METHOD__与__FUNCTION__的区别
2014/09/29 PHP
thinkphp中的多表关联查询的实例详解
2017/10/12 PHP
tp5(thinkPHP5)框架连接数据库的方法示例
2018/12/24 PHP
BOOM vs RR BO5 第三场 2.14
2021/03/10 DOTA
20款效果非常棒的 jQuery 插件小结分享
2011/11/18 Javascript
jQuery使用数组编写图片无缝向左滚动
2012/12/11 Javascript
创建你的第一个AngularJS应用的方法
2015/06/16 Javascript
浅谈jQuery 选择器和dom操作
2016/06/07 Javascript
JS中split()用法(将字符串按指定符号分割成数组)
2016/10/24 Javascript
jquery版轮播图效果和extend扩展
2017/07/18 jQuery
详解js几个绕不开的事件兼容写法
2017/08/30 Javascript
Vue2.0基于vue-cli+webpack同级组件之间的通信教程(推荐)
2017/09/14 Javascript
代码分析vue中如何配置less
2018/09/28 Javascript
js事件触发操作实例分析
2019/06/21 Javascript
Vue如何将页面导出成PDF文件
2020/08/17 Javascript
Python制作简单的网页爬虫
2015/11/22 Python
Python+django实现简单的文件上传
2016/08/17 Python
Python常用库推荐
2016/12/04 Python
Python字符串处理实现单词反转
2017/06/14 Python
pandas.DataFrame.to_json按行转json的方法
2018/06/05 Python
Python 爬取携程所有机票的实例代码
2018/06/11 Python
Python将string转换到float的实例方法
2019/07/29 Python
Pyqt5自适应布局实例
2019/12/13 Python
Django 批量插入数据的实现方法
2020/01/12 Python
PyCharm刷新项目(文件)目录的实现
2020/02/14 Python
解决pycharm编辑区显示yaml文件层级结构遇中文乱码问题
2020/04/27 Python
用纯css3实现的图片放大镜特效效果非常不错
2014/09/02 HTML / CSS
英国领先的名牌服装折扣零售商:Brown Bag Clothing
2019/01/08 全球购物
Vita Fede官网:在意大利手工制作,在纽约市设计
2019/10/25 全球购物
摄影实习自我鉴定
2013/09/20 职场文书
建筑工程毕业生自我鉴定
2014/01/14 职场文书
同事吵架检讨书
2014/02/05 职场文书
优秀部门获奖感言
2014/02/14 职场文书
《第一朵杏花》教学反思
2014/04/16 职场文书
初三英语教学计划
2015/01/23 职场文书
协议书范文
2015/01/27 职场文书