Welcome to writebysphinx’s documentation!

目录

• 1. sphinx介绍
  • 1.1. sphinx是什么？
  • 1.2. 为什么用sphinx写文档？
  • 1.3. 为什么不推荐Markdown作为大型文档协作工具？
  • 1.4. 为什么用脚本画图？
• 2. 环境安装
  • 2.1. 安装Python虚拟机
  • 2.2. 安装sphinx
  • 2.3. 安装VSCode
  • 2.4. 安装主题
  • 2.5. 安装画图工具
  • 2.6. 安装PDF转换工具
  • 2.7. 安装Breathe
• 3. 基本用法
  • 3.1. 基本布局
  • 3.2. 制表格技巧
  • 3.3. 注意空行和空格
  • 3.4. 注意标点
  • 3.5. 使用 python 设置路径
• 4. 发布文档
  • 4.1. 通过Github和readthedoc发布
  • 4.2. 在公司内部发布
• 5. FAQ
  • 5.1. 目录设置问题
  • 5.2. 为什么有些目录没更新？
  • 5.3. Read the Docs部分设置注意点
  • 5.4. 在Sphinx上使用Markdown

Indices and tables

• 索引
• 搜索页面