最近有朋友想在windows下做个人笔记,没有找到顺手的工具,问我有什么好的工具推荐。正好前两天在网上看到一款做文档的利器sphinx+reStructText,当时在ubuntu下搭了下环境试了试,做笔记真的非常方便。今天在windows下试了试,遇到一些问题,但总算成功了,现整理如下。

简介

1  reStructuredText是什么?

reStructuredText是扩展名为.rst的纯文本文件,含义为”重新构建的文本“,是python编程语言的Docutils项目的一部分。.rst文件是一种轻量级标记语言,与html的复杂结构相比,它的设计对人更加友好,被设计为容易阅读和编写的纯文本,并且可以借助Docutils这样的程序进行文档处理,也可以转换为html或pdf等多种格式,或由Sphinx这样的程序转换为man手册等更多格式

2  sphinx是什么?

Sphinx 是一种工具,它允许开发人员以纯文本格式编写文档,以便采用满足不同需求的格式轻松生成输出。它使用 reStructuredText标记语法来提供文档控制,可以将
Sphinx想像成为一种文档框架:它会抽象化比较单调的部分,并提供自动函数来解决一些常见问题,比如突出显示标题索引和特殊代码(在显示代码示例时),以及突出显示适当的语法

环境搭建

1  搭建Python环境

sphinx和reStructuredText是python编程语言的一部分,所以需要先配置好Python环境。
在Python的官方网站下载安装程序按默认选项安装即可,默认安装路径C:\python27
需要注意的是根据你的主机是32位还是64位来选择下载哪个进行安装

2  安装setuptools

setuptools是python的一个增强工具,我们安装模块式常用的easy_install命令就是setuptools中的一个工具;
官方网站下载ez_setup.py,如下图所示,右击->目标另存为,将ez_setup.py下载到本地
然后将ez_setup.py放到python的安装目录C:\python27,如下图所示
进入dos窗口,执行以下命令安装setuptools
cd C:\python27
C:\python27\python.exe ez_setup.py

3  安装sphinx

安装完setuptools,我们就是可以只用其中的easy_install命令很简单的安装sphinx模块
进入dos界面,输入以下命令
C:\python27\easy_install.exe sphinx

4  设置环境变量

设置环境变量的作用是让你在输入命令的时候不需要在输入完整的路径,只要输入命令名称即可。
在桌面右击计算机->属性->高级系统设置->环境变量,选择系统变量的path项点击编辑,增加以下两个路径
;C:\python27;C:\python27\scripts
需要注意的是每个路径都是以英文的分号来分割,我们添加了两个路径,在这两个路径之间需要用“;”分开,另外,在第一个路径之前也需要增加一个“;”,与原有的路径进行区分
到此为止,windows下搭建sphinx+reStructuredText的工作就全部完成了。
下一节我们以一个简单的实例来展示它的强大功能

使用实例

首先在桌面建立一个空文件夹sphinx-test,在dos下进入该目录,执行以下命令
cd C:\Users\xlzh\Desktop\sphinx-test
sphinx-quickstart
运行该命令会提示很多是选项,我们只需要在project Name后写上自己的工程名称,Authors Name后写上作者名称,其他的按默认即可
命令结束后会在sphinx-test目录下生成以下几个文件
我们要编辑的就是其中的index.rst,首先我们先不着急编辑,先看一下默认的效果
进入dos窗口,进入shpinx-test目录,执行以下命令
cd C:\Users\xlzh\Desktop\sphinx-test
make.bat html

出现上面的效果说明转换html通过,会在该目录_build目录下生成响应的html文件,我们进入目录下的_build/html,使用浏览器打开index.html,查看页面效果

以上显示是默认的页面,现在让我们回过头来用记事本打开index.rst并进行编辑,增加几行代码,展示自己的东西,如下所示
需要注意的是此时的index.rst是ANSI编码的,不支持汉字,需要点击文件->另存为,保存为utf-8格式,覆盖原文件即可

修改完毕,再次运行命令

make.bat html

刷新刚才的页面看下效果吧

OK,剩下的工作就是好好学习reStructuredText语言,然后不断的make.bat html和查看页面进行调试了,注意rst文件编写如果不符合规则,make.bat的时候会提示报错信息,按照报错信息修改对应文件的对应行即可
推荐学习网站:http://jwch.sdut.edu.cn/book/rst.html,这个是reStructuredText的简明教程,这个网站本身也是reStructuredText编写的,我们可以通过点击页面左侧的show source查看右侧窗口的源码,比对源码与页面显示,学习更有效率

Windows下配置sphinx+reStructuredText详解的更多相关文章

  1. windows下的定时任务设置详解

    windows下的定时任务设置详解 一.总结 一句话总结: 1.php.exe是什么? 就是php中自带的一个exe,不是我们写的,这个exe是可以执行其他的PHP的 二.windows下的定时任务设 ...

  2. windows下安装Mysql—图文详解

    mysql安装过程及注意事项: 1.1. 下载: 我下载的是64位系统的zip包: 下载地址:https://dev.mysql.com/downloads/mysql/ 下载zip的包: 下载后解压 ...

  3. windows下安装Mysql(图文详解)

      博客园 | 首页 | 新随笔 | 联系 | 订阅 | 管理 mysql安装过程及注意事项: 1.1. 下载: 我下载的是64位系统的zip包: 下载地址:https://dev.mysql.com ...

  4. Window下配置NodeJs环境详解

        今年打算学习Web这块,所以就买了本Node.js+MongoDb+AngularJS这本书,这周天也比较忙,想着录视频(拍小片,不是AV,不要误会,是在线课程)的事情,这周又将Asp.Net ...

  5. 环境搭建文档——Windows下的Git搭建详解

    Git是一个开源的分布式版本控制系统,可以有效.高速的处理从很小到非常大的项目版本管理.具体安装步骤如下: 第一步:先从官网下载最新版本的Git 官网地址:https://git-scm.com/do ...

  6. windows下at命令使用详解

    T命令是Windows XP中内置的命令,它也可以媲美Windows中的“计划任务”,而且在计划的安排.任务的管理.工作事务的处理方面,AT命令具有更强大更神通的功能.AT命令可在指定时间和日期.在指 ...

  7. Windows下安装solr步骤详解

    Solr是一个独立的企业级搜索应用服务器,它对外提供类似于Web-service的API接口.用户可以通过http请求,向搜索引擎服务器提交一定格式的XML文件,生成索引:也可以通过Http Get操 ...

  8. Windows 7操作系统下PHP 7的安装与配置(图文详解)

    前提博客 Windows 7操作系统下Apache的安装与配置(图文详解) 从官网下载           PHP的官网 http://www.php.net/         特意,新建这么一个目录 ...

  9. CentOS 6.3下Samba服务器的安装与配置方法(图文详解)

    这篇文章主要介绍了CentOS 6.3下Samba服务器的安装与配置方法(图文详解),需要的朋友可以参考下   一.简介  Samba是一个能让Linux系统应用Microsoft网络通讯协议的软件, ...

随机推荐

  1. CSS选择符 新的认识

    以前写选择符,很少使用">"符号,一般都是使用" "空格来代替.我觉得他们都是一样的功能,另一方面是为了方便.毕竟不用按住shift. 例如: .demo ...

  2. jquery文本框验证字符长度和只能输入数字

    <input type="text" class="chujia" onkeyup="this.value=this.value.replace ...

  3. asp.net向后台传参数动态加载图片

    //向后台传参数动态加载图片 $(function() { $("#Button1").click(function() { var stockcode = getUrlParam ...

  4. Python学习笔记2(控制语句)

    1.if条件语句 if(表达式): 语句1 else: 语句2 2.if...elif...else判断语句 if(表达式1):语句1 elif(表达式2):语句2 ... elif(表达式n):语句 ...

  5. (原)Opencv中直方图均衡和图像动态范围拉伸的代码

    转载请注明出处: http://www.cnblogs.com/darkknightzh/p/5102032.html 参考网址: http://blog.csdn.net/abcjennifer/a ...

  6. 轻量级jquery框架之--工具栏(toolbar)

    工具栏需求: (1)要求工具栏可以通过JSON配置格式生成,这样可以从服务器端控制生成的JSON来控制UI层面的按钮状态 (2)可以自定义按钮的图标样式. (3)可以定义按钮事件,按钮事件需要支持以字 ...

  7. float的理解

    1.浮动包裹性——浮动具有让元素按displya:inline-block显示(如果没有设置宽度和高度,则它可以显示的尽量窄高 度尽量小).2.浮动破坏性——浮动元素漂浮在标准流之上(但没有脱离文档流 ...

  8. mysql 关键字bug

    今天运行语句 select * from order; 出现bug: ERROR 1064 (42000): You have an error in your SQL syntax; check t ...

  9. 树上战争(HDU 2545 并查集求解点到根节点长度)

    树上战争 Time Limit: 10000/4000 MS (Java/Others)    Memory Limit: 32768/32768 K (Java/Others)Total Submi ...

  10. curl fake ip

    curl --header "X-Forwarded-For: 219.137.148.2" "http://www.x.com"