用Sphinx编写API文档

目录

• 简介
  • Docstring——将文档写在代码中
  • Sphinx——文档生成工具
• 快速上手
  • 创建一个sphinx项目
  • 自动生成API文档
  • ApiDoc使用的指令
  • 用restructuredText自己撰写文档
    • 段落
    • 行内标记
    • 列表
    • 分级
    • 代码块
    • 代码测试块
    • 代码对象
    • 指令
    • 链接
• 更多
  • 生成中文PDF
  • 更换网页主题
  • 使用readthedocs托管文档
  • 使用Markdown
  • 给其它语言生成API文档
  • 本地化文档
  • REST API
• 参考文献