Windows 下用 Sphinx 发布 HTML

先去文具店买纸笔

1. 买纸(Python)

位置:Python的官方网站
64位安装程序
32位安装程序
付钱:下载好以后直接运行.exe文件安装,那样纸就准备好了

2. 买笔(Sphinx)

位置:本机的命令行窗口

  • 在桌面左下角Windows 图标下右击,点击运行,在弹出框中输入 cmd
  • 在桌面左下角Windows 图标下右击,点击运行,在弹出框中输入 Windows PowerShell
    付钱:
    在打开的命令行窗口,直接键入 pip install -U Sphinx
    字母 U 和字母 S 大写,一定要注意哇,不然这个命令是无效嘚
    店家给你备货现场:
    image.png

    到手:
    image.png

准备就绪,文思泉涌

3. 打开笔盖

在命令行界面输入 sphinx-quickstart
启动之后,Sphinx 会问你许多问题,还会给出一些提示,大部分只需回答是(y)或否(n),少数需要键入项目名称等,只要一一作答即可。
终于回答了所有问题,Sphinx 会为我们创建一个基本的文档结构,包括1个 source 文件夹

image.png

2个 makefile 的文件
image.png

4. 分章写作

在source 文件夹里添加我们用 rst 写好的一个个文档

5. 编纂目录

打开source 文件夹中的index.rst 文件,在目录树 toctree 里面添加我们写的文档信息

昭告天下

6. 出版

在命令行里输入 make html
Sphinx 会为我们生成一个 build 文件夹,里面就是发布好的 html 文件了,这样我们的文档就按照 toctree 的层级编纂好了

完美~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 摘抄:http://blog.163.com/sbtaot/blog/static/128303760200982...
    cqlina阅读 9,845评论 0 5
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,347评论 19 139
  • .bat脚本基本命令语法 目录 批处理的常见命令(未列举的命令还比较多,请查阅帮助信息) 1、REM 和 :: 2...
    庆庆庆庆庆阅读 12,557评论 1 19
  • 1、去除页眉的横线方法两则 在页眉插入信息的时候经常会在下面出现一条横线,如果这条横线影响你的视觉,这时你可以采用...
    南屋阿米佛头阅读 9,918评论 4 37
  • 《安济桥》 清·饶梦铝 谁到桥头问李春, 仙驴仙迹幻成真。 长虹应卷涛声急, 似向残碑说故人。
    喜亭_bf8f阅读 2,481评论 0 3