美文网首页程序员
Windows 下用 Sphinx 发布 HTML

Windows 下用 Sphinx 发布 HTML

作者: Wontaigne | 来源:发表于2018-07-19 16:48 被阅读0次

先去文具店买纸笔

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 的层级编纂好了

完美~

相关文章

网友评论

    本文标题:Windows 下用 Sphinx 发布 HTML

    本文链接:https://www.haomeiwen.com/subject/uagzpftx.html