正点原子Sphinx + Rst + Github + Read the Docs + Pandoc快速入门

目录

• 简介
  • reStructuredText
  • Sphinx
  • Github
  • Read the docs
  • pandoc
• 环境搭建
  • 安装Python环境
  • 安装pip插件
  • 安装Sphinx插件
  • 安装sphinx-rtd-theme
  • 安装BeautifulSoup
  • 安装第三方html解析器lxml
  • 安装纯Python实现的html5lib解析器
  • 安装LaTeX
  • 安装sublime编辑器
  • pandoc安装
• 创建编辑
  • 创建文件夹
  • 创建编辑环境
  • sphinx支持MarkDown
  • sphinx支持引用
  • MarkDown的主题样式theme
  • 生成文件及PDF
• Rst标记语言语法
  • 标题
  • 段落
  • 行内标记
  • 表格
  • 源代码及高亮
  • 引用
    • 引用图片
    • 超链接
  • 更多语法请参考
• pandoc使用
  • word转rst
• Read the Docs与Github关联
• 部署到公司服务器
  • Read the DocsS构建后部署
  • 本地编译后部署
• 文档编写流程
• 注意事项
  • 搭建环境时的注意事项
  • 编写在线文档时的注意事项
• 关于正点原子