Windows下配置sphinx+reStructuredText详解

最新推荐文章于 2024-08-13 09:02:51 发布

高木木的博客

最新推荐文章于 2024-08-13 09:02:51 发布

阅读量703

点赞数

分类专栏： linux sphinx reStructuredText

本文链接：https://blog.csdn.net/qq_39866513/article/details/89955404

版权

本文详细介绍了如何在Windows上配置sphinx和reStructuredText。首先讲解了reStructuredText的基本概念，接着阐述了sphinx的作用。然后逐步指导如何搭建Python环境，安装setuptools和sphinx，以及设置环境变量。最后通过一个简单的实例展示了如何创建和编辑rst文件，以及生成HTML页面的过程。

摘要由CSDN通过智能技术生成

Windows下配置sphinx+reStructuredText详解
最近有朋友想在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:\python37
需