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使用踩坑记录
描述使用 pip 安装sphinx后,按照教程建立了一个新的py文件,如下 # run.py def run(name):"""this is how we run:p ...
python转写java踩坑记录
数组如何初始化 String[] words = new String[]{"1", "2"}; 列表如何由单个对象初始化 Arrays.asList(obj) ...
在linux上运行python脚本(安装pytorch踩坑记录,pyinstaller使用方式,构建docker镜像)
背景脚本需要导入pytorch等库才能运行. 脚本在windows上运行成功,尝试放到linux上运行. linux服务器内存较小. 方法一:在linux上安装依赖把脚本放到linux上,直接安装 ...
python 数字索引失败踩坑记录
原来半角和全角输入下的数字是不一样的!!!难怪我一直索引失败找不同: 1. 半角输入下的1 # 查看ASCII码 ord('1') 输出:49 2. 全角输入下的1 ord('1') 输出:6529 ...
VS Code Python 代码智能提示（自动补全）编译环境设置踩坑记录
VS Code Python 编译环境设置踩坑记录本菜鸡非常喜欢VS code的简洁风格,而且跟原来再用的VS2017相比简直不要太快,前段时间电脑重装之后又要在windows系统上重新搭建整套环境 ...
Python打包工具Pyintealler打包py文件为windows exe文件过程及踩坑记录+实战例子
Python打包工具Pyintealler打包py文件为windows exe文件过程及踩坑记录+实战例子目录 Python打包工具Pyintealler打包py文件为windows exe文件过程 ...
使用Java读取 “Python写入redis” 的数据踩坑记录
https://my.oschina.net/u/2338224/blog/3061507 使用Java读取 "Python写入redis" 的数据踩坑记录 https://seg ...
如何运行开源游戏？八分音符酱python版踩坑记录
如何运行开源游戏?八分音符酱python版踩坑记录如何从零到一搭建一个python游戏?这篇博客将以八分音符酱介绍详细过程. 下载源代码源代码搭建python环境参考此网站此游戏运行基于pyt ...
TVM: Deep Learning模型的优化编译器(强烈推荐, 附踩坑记录)
本文作者是阿莱克西斯,原载于知乎,雷锋网(公众号:雷锋网)获得授权转载. (前排提醒,本文的人文内容部分稍稍带有艺术加工,请保持一定的幽默感进行阅读) 关注我最近想法的同学应该知道我最近都在把玩 TV ...

python sphinx_Python Sphinx使用踩坑记录

python sphinx_Python Sphinx使用踩坑记录相关推荐

最新文章

热门文章