python sphinx_Python Sphinx使用实例及问题解决

这篇文章主要介绍了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

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'

]

再次尝试，终于成功了…

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

python sphinx_Python Sphinx使用实例及问题解决相关推荐

python sphinx_Python Sphinx使用踩坑记录
描述使用 pip 安装sphinx后,按照教程建立了一个新的py文件,如下 # run.py def run(name): """ this is how we run ...
《 Python List列表全实例详解系列（五）》——修改元素(修改单个、修改一组）
< Python List列表全实例详解系列(五)> --修改元素(修改单个.修改一组) 接上一篇:< Python List列表全实例详解系列(四)>__列表删除元素(4种 ...
《 Python List列表全实例详解系列（三）》——列表添加元素（4种方法）
< Python List列表全实例详解系列(三)> --列表添加元素(4种方法) 接上一篇:< Python List 列表全实例详解(二)>__访问列表元素(索引和切片)列 ...
《 Python List列表全实例详解系列（四）》__列表删除元素（4种方法）删除重复元素（去重）(8种方法）
< Python List列表全实例详解系列(四)> __列表删除元素(4种方法)删除重复元素(去重)(8种方法) 我的技术成长&学习资料整理分享之路我遇到问题查找资料时,经常 ...
《 Python List 列表全实例详解系列（八）》__随机列表元素
< Python List 列表全实例详解系列(八)> __随机列表元素本章目录: 十.随机列表元素方法1:random.shuffle 方法2:random.sample 十.随机列 ...
《 Python List 列表全实例详解系列（九）》__列表反转（6种方法）
< Python List 列表全实例详解系列(九)> __列表反转(6种方法) 本章目录: 十一.列表反转的6种方法 (11.1).通过列表的切片操作实现列表反转 (11.2).使用列表 ...
《 Python List列表全实例详解系列（二）》__创建列表（5种方式）
< Python List列表全实例详解系列(二)> __创建列表(5种方式) 上一篇:< Python List 列表全实例详解系列(一)>__系列总目录.列表概念本章目录 ...
Python局域网socket无法连接的问题解决
Python局域网socket无法连接的问题解决服务器端的socket监听的是否是服务器的IP地址(并不是什么'localhost'或者'127.0.0.1'这种).即客户端需要连接的IP地址填入即 ...
python键盘输入代码,python监控键盘输入实例代码
本文研究的主要是python监控键盘输入的相关代码,用到了os,sys,time等,具体实现代码如下: #!/usr/bin/env python # -*- coding: utf-8 -*- im ...

python sphinx_Python Sphinx使用实例及问题解决

python sphinx_Python Sphinx使用实例及问题解决相关推荐

最新文章

热门文章