使用Sphinx编写文档

栏目: 后端 · 发布时间: 7年前

内容简介:操作系统 : Windows7_x64Python 版本 : 2.7.10Sphinx 版本 :

操作系统 : Windows7_x64

Python 版本 : 2.7.10

Sphinx 版本 :

官方网址: http://sphinx-doc.org

github地址: https://github.com/sphinx-doc/sphinx

安装Sphinx

使用pip安装:

pip install -U Sphinx
pip install sphinx_rtd_theme

从源码安装:

git clone https://github.com/sphinx-doc/sphinx
cd sphinx
pip install .

使用Sphinx

创建项目

在控制台输入以下命令:

sphinx-quickstart

根据实际情况填写。

编写项目

index.rst示例代码:

.. _tutorial-index:

.. highlight:: python
    :linenothreshold: 0

sphinx示例文档
=============
: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地址:

https://github.com/mike-zhang/mikeBlogEssays/blob/master/2018/ 20181006_使用Sphinx编写文档.rst

欢迎补充


以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持 码农网

查看所有标签

本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们

计算机算法基础

计算机算法基础

沈孝钧 / 机械工业出版社 / 2013-11 / 45.00元

计算机算法是计算机科学的一个重要分支,也是一个难点。本书作者根据自己20多年在国内、国外的教学与科研实践,系统地总结了计算机算法的设计与分析方法,覆盖了大部分最主要的算法技术,包括:分治法、贪心法、动态规划、图的遍历技术、穷举搜索等,涉及一系列重要的算法问题,包括排序问题、选择问题、最小生成树问题、最短路径问题、网络流问题、二分图的匹配问题、字符串的匹配问题和几何算法问题等,还介绍了问题本身的计算......一起来看看 《计算机算法基础》 这本书的介绍吧!

HTML 压缩/解压工具
HTML 压缩/解压工具

在线压缩/解压 HTML 代码

URL 编码/解码
URL 编码/解码

URL 编码/解码

SHA 加密
SHA 加密

SHA 加密工具