前言

本篇记录使用sphinx生产成python项目文档的方法。

安装sphinx

直接通过pip安装sphinx：

pip install sphinx

生成配置文件

进入项目根目录，创建doc文件夹，生成配置文件：

mkdir doc
cd doc
sphinx-quickstart

出现以下提示：

Separate source and build directories (y/n) [n]: y
Project name:
Author name(s):
Project version []:
Project language [en]:

修改配置文件

安装sphinx主题美化文档：

pip install sphinx_rtd_theme

修改doc/source/conf.py文件：

import os
import sys
# 添加源码路径
sys.path.append(os.path.join(os.path.abspath(__file__), '../../')# 添加sphinx自动生成脚本
extensions = ['sphinx.ext.autodoc']# 更改sphinx主题（美观一些）
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

生成rst文件

根据配置文件与源码，生成rst文件：

sphinx-apidoc -o source ../

编译文档

通过rst文件和makefile文件，生成文档：

make html

然后在doc/build下有几个.html文件，打开index.html就能看到文档整体了。

Python: 使用sphinx生成python项目文档相关推荐

在Ubuntu 14.04 64bit上使用Sphinx转换MonaServer项目文档
这几天看到网上出了个Cumulus的后继项目MonaServer, 官网是 http://www.monaserver.ovh/ 看介绍相当强悍, 包括支持RTMP, RTMFP, RTSP, HTT ...
python生成api文档_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
python api接口生成_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
自动生成python接口文档_Django自动生成Swagger接口文档
Django自动生成Swagger接口文档 1. 前言当接口开发完成,紧接着需要编写接口文档.传统的接口文档通常都是使用Word或者一些接口文档管理平台进行编写,但此类接口文档维护更新比较麻烦,每次 ...
Python 开发工具集：关于文档、测试、调试、程序的优化和分析
Python 开发工具集:关于文档.测试.调试.程序的优化和分析原文 http://segmentfault.com/a/1190000000410521 Python已经演化出了一个广泛的生 ...
Python Tutorial中英双语对照文档5
Python Tutorial中英双语对照文档4 CHAPTER THIRTEEN WHAT NOW? 现在咧? Reading this tutorial has probably reinforc ...
【Python】导出docx格式Word文档中的文本、图片和附件等
[Python]导出docx格式Word文档中的文本.图片和附件等零.需求为批量批改学生在机房提交的实验报告,我需要对所有的实验文档内容进行处理.需要批量提取Word文档中的图片和附件以便进一步检 ...
Python Tutorial中英双语对照文档2
接 Python Tutorial中英双语对照文档1 CHAPTER SIX MODULES 模块 If you quit from the Python interpreter and enter ...
Python Tutorial中英双语对照文档3
接 Python Tutorial中英双语对照文档2 CHAPTER NINE CLASSES 类 Classes provide a means of bundling data and funct ...
python自动办公 pdf_Python将word文档批量转PDF
1 ''' 2 #python批量将word文档转换成PDF文件3 ''' 4 #导入所需库 5 from docx importDocument6 from docx.enum.text impor ...

Python: 使用sphinx生成python项目文档