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

   intro


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

intro.rst内容如下

这里是一个文章的题目
============================
这里是段落内容

这里是文章的段落标题
--------------------

无序列表

 * 元素1
 * 元素2

有序列表

 #. 元素1
 #. 元素2

行内标记
-------------
*斜体标记*
**加粗标记**

在根目录下输入 make html即可生成静态文档网页
这里写图片描述

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值