博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
使用Sphinx编写文档
阅读量:6329 次
发布时间:2019-06-22

本文共 671 字,大约阅读时间需要 2 分钟。

操作系统 : Windows7_x64

Python 版本 : 2.7.10

Sphinx 版本 :

官方网址:

github地址:  

安装Sphinx

使用pip安装:

pip install -U Sphinxpip install sphinx_rtd_theme

从源码安装:

git clone https://github.com/sphinx-doc/sphinxcd sphinxpip install .

使用Sphinx

创建项目

在控制台输入以下命令:

sphinx-quickstart

根据实际情况填写。

编写项目

index.rst示例代码:

.. _tutorial-index:.. highlight:: python    :linenothreshold: 0sphinx示例文档=============:Release: |version|:Date: |today|欢迎阅读sphinx示例文档=============================================内容示例:.. toctree::   :maxdepth: 2   test1.rst

index.rst 为主文件

test1.rst 为具体内容

test1.rst示例内容:

rst语法简介===========空行分段----------第一段内容。第二段和第一段间有空行。

编译项目

生成html文档

sphinx-build -b html source/ build/

本文github地址:

欢迎补充

转载地址:http://vuwoa.baihongyu.com/

你可能感兴趣的文章
lemon OA 下阶段工作安排
查看>>
WCF X.509验证
查看>>
Fatal error: Class 'GearmanClient' not found解决方法
查看>>
jsoup分解HTML DOM
查看>>
Axure RP介绍
查看>>
ini_set()函数的使用 以及 post_max_size,upload_max_filesize的修改方法
查看>>
联想S720/S720i通刷刷机包 Vibe V1.0
查看>>
java异常 之 异常的层次结构
查看>>
T - stl 的mapⅡ
查看>>
Atitit .c#的未来新特性计划草案
查看>>
mysql分表技术
查看>>
.Net 垃圾回收和大对象处理 内存碎片整理
查看>>
HiKey连接
查看>>
wget 参数大全
查看>>
使用Loadrunner进行文件的上传和下载
查看>>
Linux C 静态库(.a) 与 动态库(.so) 的详解
查看>>
JS函数
查看>>
sql语句分组/排序/计算总数/连接等sql语句书写
查看>>
MVC5 的MicrosoftOwinSecurity扩展插件——微信,QQ登录第三方源码
查看>>
分布式系统理论基础 - CAP
查看>>