利用Sphinx编写文档



1、Sphinx简介和使用理由

=========

Sphinx是一个用Python语言编写而成的文档编写工具。用Sphinx编写文档的时候,用户只需要编写符合Sphinx格式要求的纯文本源文件,然后通过Sphinx的命令就可以把纯文本源文件编译成html、pdf等常用格式的文档,这样就实现了通过文本文件自动生成html、pdf等格式文档的功能。

编写文档直接用Word不就是挺好的吗?为什么又要用Sphinx来写纯文本格式的文档呢?

这是因为Sphinx中的文本格式文档可以用版本控制系统跟踪它的变更,同时呢,它又可以非常轻松地生成多种的目标文档格式,比如编写一份Sphinx文档,然后通过工具就用这一份文档生成html、pdf、epub等其他格式的文档了,编写一种文本格式的文档,可以得到很多种其他格式的文档。

然而,word想要转成html就没有那么容易了,而且word文件是二进制文件,所以无法用版本控制系统来跟踪变更。

2、Sphinx在Windows下的安装

===================

Sphinx是用Python语言写成的软件,所以在安装Sphinx之前首要先要安装Python。

Python安装好之后,可以通过Python自带的Pip工具来安装Sphinx。只需要下面这一条命令,就可以完成Sphinx的安装:

pip install Sphinx

3、利用Sphinx制作文档的一般步骤

=====================

一般情况下,用Sphinx来写文档的时候,首先要创建一个Sphinx工程,就像要编写C语言程序在IDE中要建一个工程是一样的道理。建好工程,之后就可以往这个工程中写自己的文档源文件了。源文件编写完成后,就可以生成目标格式的文档了,如果想要html格式就用相应的命令,想要pdf格式也可以用对应的命令来生成。

所以,通常就这么三步:

(1)建文档项目

(2)写文档源文件

(3)编译生成目标格式的文档

4、Sphinx基础知识

============

这里简单介绍一些Sphinx的文档的基本编写知识。详细的情况可以参考《参考资料1》和中文版的《Sphinx使用手册》。

5、发布文档

========

发布文档是什么意思呢?因为Sphinx写文档可以编译成html格式,那么html格式的文档,就可以发布在网上,大家像看网站那样看文档。有一个叫readthedocs.org的网站就可以托管Sphinx生成的文档。

详情可以参考《参考资料4》

参考资料

1、https://www.ibm.com/developerworks/cn/opensource/os-sphinx-documentation/

2、http://www.jianshu.com/p/56515db85690

3、http://zh-sphinx-doc.readthedocs.io/en/latest/contents.html

4、http://avnpc.com/pages/writing-best-documentation-by-sphinx-github-readthedocs

时间: 2024-08-14 14:55:51

利用Sphinx编写文档的相关文章

利用print2flashsetup.exe文档转swf

通过使用Print2Flash您可以轻松的将您的文档转换成真正的Adobe Flash格式,最好的保证您的内容将实际可见,与其他格式相比,它并不存在查看工具的安装问题. Print2Flash中有一个Interop.Print2Flash3.dll 准备工作: 1:先安装print2flashsetup.exe并启动windows服务. 2:确定电脑安装了Microsoft Office 软件. 3:创建项目并添加引用Interop.Print2Flash3.dll,如上图. 4:还需要安装fl

论编写文档的重要性

现代信息技术经过几十年的发展,人们的生活和工作几乎和电脑息息相关了.而对于经常使用电脑的人,会写文档就成为了工作必要的一部分. 文档是软件开发使用和维护中的必备资料,能提高软件开发的效率,保证软件的质量,并且在软件的使用过程中有指导.帮助.解惑的作用,尤其在维护工作中,文档是不可或缺的资料. 我们不止要会写文档,还要写出好的文档,我们写出的文档必须内容详细且明了,而且文档的排版必须按照规范,这样才能让别人能清楚的看出本文档的编写目的以及中心思想. 在需求文档的编写过程中如果质量控制不到位,自然就

利用nginx实现文档服务器限速

在平时工作中,我们为了一些软件文档方便查看通常会搭建一些目录服务(类似yum源),为控制下载速度和下载总数,我们可以利用nginx的ngx_http_limit_conn_module模块. 首先在http段添加如下配置: limit_conn_zone $binary_remote_addr zone=perip:10m; limit_conn_zone $server_name zone=perserver:10m; 在对应的location中添加如下配置,虽然这个模块作用域可以是http,

php学习笔记:读取文档的内容,利用php修改文档内容

直接上代码 <?php /** * Created by PhpStorm. * User: Administrator * Date: 2016/9/10 0010 * Time: 20:27 */ header("Content-type: text/html; charset=gbk"); if(isset($_POST['subbtn'])){//如果提交,就开始执行操作 //执行修改: $fileContent=$_POST['fileContent'];//获取输入框

利用python处理文档中各字段出现的次数并排序

1 import string 2 path = 'waldnn' 3 with open(path,'r') as text: 4 words = [raw_word.strip(string.punctuation).lower() for raw_word in text.read().split()] 5 words_index = set(words) 6 counts_dict = {index:words.count(index) for index in words_index}

Sphinx - 帮助文档制作工具

http://www.sphinx-doc.org/en/stable/

POSTMAN编写文档

第一步:创建文件夹: 同时创建全局变量: 第二步:创建分组文件夹: 第三步:添加请求: 类似正常调试,然后多了一步保存: 保存: 请求方式发生相应变化,同时颜色也发生变化,说明保存成功: =============== 使用:一种收费模式: 另一种是导出本地: 导出的是json格式文件: 原文地址:https://www.cnblogs.com/zhzhlong/p/9409420.html

从零开始编写自己的C#框架(4)——文档编写说明

原文:从零开始编写自己的C#框架(4)--文档编写说明 在写本系列的过程中,了解得越多越不知道从哪里做为切入点来写,几乎每个知识点展开来说都可以写成一本书.而自己在写作与文档编写方面来说,还是一个初鸟级别,所以只能从大方面说说,在本框架开发所需的范围内来讲述相关要用到的知识点,至于要更深入的去了解,请大家观看其他大牛的博客或购买书籍来学习. 为了加快进度,会对目录进行修改,将一些知识点合并或在后面使用的章节再进行描述. 谢谢大家的支持,如果您觉得本文对您有所帮助,请帮忙点击支持或发表评论. 在开

对于初学者文档应该怎么编写呢?使用什么模板或格式?

在一个项目从开始提出需求到实施结束,这个过程会涉及很多文档的编写,在编写的过程中,对于初学者来说并不好把握,常常会不知道使用什么格式.排版,内容要怎么来写. 一般来说通用的模板内容大都内容全面.详细,比较复杂,初学者没有经验写起来会比较吃力.所以编写时可以使用通用模板进行模仿,但不用全部照搬. 实际上编写文档就像写作文,只要条理清晰的讲述出相关内容,突出重点,不要偏离该文档主题就可以了.当然如果你能详细的将5个W2H原则说明清楚,再配上相应的图例(流程图),那就更棒了. 5个W2H原则说明:1.