reStructuredText相关资源

语法

https://macplay.github.io/posts/cong-markdown-dao-restructuredtext/

http://www.bary.com/doc/a/228277572381775842/#d46f82fd

工具

sphinx：文档系统
http://www.sphinx-doc.org/en/master/contents.html

nikola：静太博客系统
https://www.getnikola.com/

netlify: 站点布置
https://www.netlify.com/

使用markdown的静态博客系统
mkdocks

hexo

sphinx & github & readthedoc 搭建静态博客写作平台

sphinx

在wsl中安装好的python环境，使用pip 安装 sphinx，没什么问题。
按教程的命令新建一个项目。应该要先新建一个文件夹。

github

在GITHUB新建一个库，准备用来接收SPHINX的项目。

在本地把github上新建立的库clone下来

这样，本地的库就和远程库连接起来了。

进入到本地库目录，开始创建文档

sphinx-quickstart

上述命令会在目录中创建一些文件，包括配置文件和一个make文件。
把内容组织好以后，可以直接用make命令得出想要的格式。这里我我用的是

make html

把项目同步到github

前面还还包括设置git环境，设置公钥等。

# 如果是先在本地建库，连接到github远程库的话，如下操作
git init
git add .
git commit -m
git remote add origin [email protected]:xxxxx/mybooks
git push -u origin master

# 如果是从远程库克隆回来的库
git add .
git commit -m 'something'
git push

在github远程库中设置webhook

我推送上去后，就自动生成了，不知道为什么。试过两次好象确实都是自己设置好了的。

登录readthedoc

1. 用github账号登录readthedoc
2. 在项目中选择github中的库
   然后会自动deploy
   我在前面几次失败了，后来看了这个成功了。https://stackoverflow.com/questions/56336234/build-fail-sphinx-error-contents-rst-not-found

If you have your own conf.py file, it overrides Read the Doc's default conf.py. By default, Sphinx expects the master doc to be contents. Read the Docs will set master doc to index instead (or whatever it is you have specified in your settings). Try adding this to your conf.py:

master_doc = 'index'

后续操作

1. 用vscode编辑文件
2. 在项目文件根目录下，git三连推。
3. 在readthedoc项目页面上，重新构建。

目前第三步还没有成功，不知道为什么。也许要多等一段时间。
readthedoc上应该就会自动渲染更新了。