python sphinx 文档自动生成方法
## sphinx 生成开发文档
#### 配置
1. 运行如下命令,即可生成 conf.py index.rst Makefile 三个文件: `sphinx-quickstart`
2. conf.py 负责全局配置:
1. 注意一定要启用 `autodoc`
2. `autodoc` 对应配置在: `extensions = ['sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.viewcode']
`
3. 配置 path 以供sphinx 在 `autodoc` 时能够 `import` 对应的 module `sys.path.insert(0, os.path.abspath('.'))` 3. index.rst 负责首页的布局, 需要声明 `autodoc`的位置,以及对应的 module
1. 在module的__init__.py文件中声明好 __all__
2. 在 index.rst 中加入如下配置,注意空格格式 .. automodule:: data_engineer.bark_engine
:members:
:undoc-members:
:show-inheritance:
4. 设置主题:ReadTheDocs
1. 安装: pip install sphinx_rtd_theme 2. 配置conf.py: import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] #### 执行
- sphinx-build -b html . _build
#### 参考:
1. 生成配置文件:sphinx-quickstart
2. 配置source 扫描:https://www.ctolib.com/topics-46641.html
3. 设置主题: https://segmentfault.com/a/1190000007233355
python sphinx 文档自动生成方法的更多相关文章
- sphinx:python项目文档自动生成
		
Sphinx: 发音: DJ音标发音: [sfiŋks] KK音标发音: [sfɪŋks] 单词本身释义: an ancient imaginary creature with a lion's bo ...
 - word文档自动生成方法
		
创建word文档需要几个接口类,常用application,document,documents,selection等.但word的功能复杂,要认识到每一个类的功能是不可能的.常用的方法是在word的 ...
 - Word 2010文档自动生成目录和某页插入页码
		
一.Word 2010文档自动生成目录 关于Word文档自动生成目录一直是我身边同学们最为难的地方,尤其是毕业论文,经常因为目录问题,被要求修改,而且每次修改完正文后,目录的内容和页码可能都会发生变化 ...
 - VS文档自动生成
		
VS2008文档自动生成 (发现,Sandcastle主要是用于C#项目.里面的注释都是XML格式的.不太适合VC的.最终还是得用Doxygen) 一.Sandcastle简介: Sandcastle ...
 - springboot成神之——swagger文档自动生成工具
		
本文讲解如何在spring-boot中使用swagger文档自动生成工具 目录结构 说明 依赖 SwaggerConfig 开启api界面 JSR 303注释信息 Swagger核心注释 User T ...
 - django接口文档自动生成
		
django-rest_framework接口文档自动生成 只针对用到序列化和返序列化 一般还是用第三方yipi 一.安装依赖 pip3 install coreapi 二.设置 setting.py ...
 - java 文档自动生成的神器 idoc
		
写文档 作为一名开发者,每个人都要写代码. 工作中,几乎每一位开发者都要写文档. 因为工作是人和人的协作,产品要写需求文档,开发要写详细设计文档,接口文档. 可是,作为一个懒人,平时最讨厌的一件事情就 ...
 - 优于 swagger 的 java markdown 文档自动生成框架-01-入门使用
		
设计初衷 节约时间 Java 文档一直是一个大问题. 很多项目不写文档,即使写文档,对于开发人员来说也是非常痛苦的. 不写文档的缺点自不用多少,手动写文档的缺点也显而易见: 非常浪费时间,而且会出错. ...
 - API的文档自动生成——基于CDIF的SOA基本能力
		
当前,作为大部分移动app和云服务后台之间的标准连接方式,REST API已经得到了绝大部分开发者的认可和广泛的应用.近年来,在新兴API经济模式逐渐兴起,许多厂商纷纷将自己的后台业务能力作为REST ...
 
随机推荐
- jarvis OJ WEB题目writeup
			
0x00前言 发现一个很好的ctf平台,题目感觉很有趣,学习了一波并记录一下 https://www.jarvisoj.com 0x01 Port51 题目要求是用51端口去访问该网页,注意下,要用具 ...
 - 在windows上安装redis并设置密码
			
在windows上安装redis Redis是一个开源,先进的key-value存储,并用于构建高性能,可扩展的Web应用程序的完美解决方案. Redis从它的许多竞争继承来的三个主要特点: Redi ...
 - Redis自学笔记:3.3入门-散列类型
			
3.3散列类型 3.3.1介绍 散列类型不能嵌套其他数据类型,一个散列类型可以包含至多232-1个字段 散列类型适合存储对象:使用对象类别和ID构成键名,使用字段表示对象的数据, 而字段值则存储属性值 ...
 - 【DWM1000】 code 解密7一ANCHOR接收到BLINK
			
接着之前ANCHOR的代码分析,但接收到无线数据,应该执行如下代码 case TA_RX_WAIT_DATA : //already recive a message ...
 - 第一章  初始STM32
			
1.3什么是STM32? ST是意法半导体,M是MIcroelectronisc的缩写,32表示32位. 合起来就是:ST公司开发的32位微控制器. 1.4 STM32 能做什么? STM32属于一个 ...
 - [Vijos1130][NOIP2001]数的计数 (递推)
			
自己的递推一塌糊涂 考前抱佛脚 #include<bits/stdc++.h> using namespace std; ]; int main() { int n;scanf(" ...
 - 狡猾的商人 [HNOI2005] [一题双解]
			
Description 刁姹接到一个任务,为税务部门调查一位商人的账本,看看账本是不是伪造的.账本上记录了n个月以来的收入情况,其中第i 个月的收入额为Ai(i=1,2,3...n-1,n), .当 ...
 - UE4入门(二)建立和打开项目
			
1.双击电脑桌面上的Unreal Engine 2.见下图 建立c++或者蓝图项目: 蓝图是什么? 蓝图种类: 接口:
 - centos6.8 固定IP
			
# vi /etc/sysconfig/network-scripts/ifcfg-eth0 DEVICE=eth0 BOOTPROTO=static IPADDR=192.168.0.116 NET ...
 - ./configure && make && make install 编译安装和卸载 (Linux)
			
./configure && make && make install 编译安装和卸载 (Linux) 正常的编译安装/卸载: 源码的安装一般由3个步骤组成:配置( ...