一、安装
pip install sphinx
mkdir mybook
cd mybook
sphinx-quickstart
安装autobuild工具
上面使用make html的方式编译,编译完后需要打开html文件来查。
还有一种HTTP服务的方式,可以在浏览器器中通过ip地址来查看,该方式需要安装自动build工具:
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple sphinx-autobuild
然后使用如下编译指令进行编译
sphinx-autobuild source build/html
编译结果如下:
打开地址http://127.0.0.1:8000/
后,所有的修改都会立即在网页上生效(和React很像)。不用每次修改后再执行make html或者sphinx-serve -b build -p 4000
目录创建和分页
接下来,我们为日记添加一级子目录。先在 source/index.rst 中添加路径信息。
我的日记
=================================
.. toctree::
:maxdepth: 2
:caption: Contents:
2020/index
about
在 source 目录下新建一个名为“2020”的文件夹,在“2020”文件夹中再创建“春、夏、秋、冬”四个文件夹,并且在其中分别创建 contents.rst 文件。最后,别忘了还有要新建一个 index.rst 文件。这一步完成后,2020 目录结构如下:
2020
├── index.rst
├── 春
│ └── contents.rst
├── 冬
│ └── contents.rst
├── 秋
│ └── contents.rst
└── 夏
└── contents.rst
在 2020/index.rst 文件中添加如下内容。
2020年
=================================
.. toctree::
:maxdepth: 2
春/contents
夏/contents
秋/contents
冬/contents
以及四个 contents.rst 文件的内容:
- 春/contents.rst
春季
========
春眠不觉晓,处处闻啼鸟。
- 夏/contents.rst
夏季
========
夏早日初长,南风草木香。
- 秋/contents.rst
秋季
========
秋风吹不尽,总是玉关情。
- 冬/contents.rst
冬季
========
冬尽今宵促,年开明日长。
好啦!打开浏览器看一下吧~
这里默认是rst的文件(即sphinx文件),如果我们用markdown的语法,那么就将目录后的文件改成md,也就没问题了。
后续还可以推送到github或者sphinx的平台,免费发布出去。
参考
www.cnblogs.com/hiyong/p/15… zhuanlan.zhihu.com/p/384863296 holbrook.github.io/2017/11/10/… silverrainz.me/blog/sphinx…