Visual Studio Code+sphinx写作环境搭建

准备工具

Python 3.4

Visual Studio Code

Git


1.安装 sphinx和自动build插件

pip install sphinx sphinx-autobuild


2.安装 restructuredtext-lint

pip install restructuredtext-lint

3.VScode插件安装

3.1安装插件 reStructuredText

它提供了.rst文件的预览功能十分便捷。

3.2安装插件 Table Formatter

由于reStructuredText做表格特别麻烦,这个插件可以帮助你做表格,只需要把关键的标记写对,其余的都会自动补全而且效果十分美观。

注意: 插件安装完成之后需要点击重新加载方能生效

4.新建写作项目

sphinx-quickstart

安装主题

pip install sphinx_rtd_theme

实时预览

sphinx-autobuild docs docs/_build/html

注意:

docs是你项目的文件夹名称,需要在项目的上一级目录执行以上指令。

运行成功后,访问 http://127.0.0.1:8000


参考资料

[1] http://avnpc.com/pages/writing-best-documentation-by-sphinx-github-readthedocs

写最好的文档:Sphinx + Read the Docs

[2] https://www.jianshu.com/p/78e9e1b8553a

如何用 ReadtheDocs、Sphinx 快速搭建写书环境

[3] http://www.sphinx-doc.org/en/stable/config.html

The build configuration file

[4] https://github.com/vscode-restructuredtext/vscode-restructuredtext/blob/master/docs/sphinx.md

reStructuredText入门

[5] http://www.pythondoc.com/sphinx/rest.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • # Python 资源大全中文版 我想很多程序员应该记得 GitHub 上有一个 Awesome - XXX 系列...
    小迈克阅读 3,169评论 1 3
  • 序言 由于最近都在忙着写技术文档,所以准备总结一下我所使用的工具、以及所遇到的坑们,包括工具的选择和优缺点之类的个...
    栽生物坑里的信息汪阅读 6,383评论 0 3
  • #refer:https://www.cnblogs.com/mstmdev/p/5454981.html 1、安...
    liuzx32阅读 982评论 0 1
  • 我是偶然机会经别人推荐看中餐厅,起初我对它的认知就是不就是一个经营餐厅的真人秀嘛,不过是湖南卫视为了增加收视率的 ...
    惰性氢气阅读 387评论 0 0
  • 自由不是让你想做什么就做什么,自由是教你不想做什么就可以不做什么。 ...
    茜盐阅读 461评论 0 2

友情链接更多精彩内容