Sphinx 文档例子

建立如下图的Sphinx文档

.
├── build
├── make.bat
├── Makefile
└── source├── conf.py├── index.rst├── intro.rst├── _static└── _templates

index.rst的内容如下：

.. newproject documentation master file, created by
   sphinx-quickstart on Mon Dec 25 11:23:47 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.Welcome to newproject's documentation!
======================================.. toctree::
   :maxdepth: 2   introIndices and tables
==================* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

intro.rst内容如下

这里是一个文章的题目
============================
这里是段落内容这里是文章的段落标题
--------------------无序列表 * 元素1
 * 元素2有序列表 #. 元素1
 #. 元素2行内标记
-------------
*斜体标记*
**加粗标记**

在根目录下输入 make html即可生成静态文档网页

Sphinx 文档例子相关推荐

一个简单的XML文档例子
一个简单的XML文档例子: <?xml version="1.0"?> <note> <to>Tove</to> <from& ...
sphinx文档_使用Sphinx构建自定义文档工作流
sphinx文档 Sphinx是用于创建文档的流行应用程序,类似于JavaDoc或Jekyll. 但是,与其他工具相比,Sphinx的重组文本输入允许更高程度的自定义. 本教程将说明如何自定义Sphi ...
sphinx 文档_Sphinx轻松漂亮的文档
sphinx 文档 Sphinx是允许开发人员以纯文本格式编写文档的工具,可轻松生成满足各种需求的格式的输出. 使用版本控制系统跟踪更改时,这将很有帮助. 纯文本文档对于跨不同系统的协作者也很有用. ...
Sphinx API文档例子
index.rst文档内容: .. newproject documentation master file, created by sphinx-quickstart on Mon Dec 25 1 ...
Sphinx文档的展示-个人学习笔记
文章目录背景介绍环境搭建 1.申请一台服务器 2.安装环境 3.ssh登录 4.安装HTTP服务 5.浏览器访问背景介绍在学习了[How TO]-如何使用Sphinx编写漂亮的文档一问之后,我 ...
SPHINX 文档写作工具安装简要指南 - windows 版 - 基于python
此教程基于本地己安装好 PYTHON 并配置过全局变量:一定具备相应的基础再操作: 上传图片以免产生误导,以下为文字描述,按下列操作即可: 下载 get-pip.py脚本; python get-pi ...
Sphinx文档生成工具（二）
rst语法官方的语法手册行内的样式: #斜体 *message* #粗体 **message** #等宽不能有换行 ``message`` 标题一级标题 ^^^^^^^^ 二级标题 ----- ...
php 微信接口文档例子,微信开发之群发(示例代码)
/* Author:yf 使用说明:微信公众号无限群发接口,使用实例: $test = new SendAllMsg("你的appId","你的appSecret&quo ...
python文档生成工具 sphinx 简介
目录简介 sphinx-build用法 Makefile选项调用sphinx-apidoc 原文出处简介 Sphinx是一个工具,她能够轻易地创建智慧和优雅的文档,她是出自Georg Brand ...

Sphinx 文档例子

Sphinx 文档例子相关推荐

最新文章

热门文章