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 git@github.com: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上应该就会自动渲染更新了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容

  • # Awesome Python [![Awesome](https://cdn.rawgit.com/sindr...
    emily_007阅读 2,203评论 0 3
  • # Python 资源大全中文版 我想很多程序员应该记得 GitHub 上有一个 Awesome - XXX 系列...
    小迈克阅读 2,965评论 1 3
  • 为子系统中的一组接口提供一个一致的界面,此模式定义了一个高层接口,这个接口使得这一子系统更加容易使用。完美解释依赖...
    DeerRun阅读 110评论 0 0
  • 她快,他也快 她慢,他亦慢 她若停下脚步 他绝不勇敢上前 他从来都是默默的跟在她身后 追逐或停驻 却永远都是漫无止...
    周怿夫阅读 493评论 0 0
  • 写作就离不开写事,事件或者故事是多数文章的主体。 那么怎么写清楚一件事情呢? 一 按照事件发展的先后顺序进行叙述,...
    写作的技巧阅读 470评论 0 3