Welcome to sphinx_demo’s documentation!

Contents:

• 1. 利用Sphinx生成项目文档
  • 安装Sphinx
  • DEMO项目案例
  • 初始化Sphinx
  • 生成项目模块文档的HTML文件
  • 修改主题
  • Markdown支持
  • Jupyter Notebook支持
  • 引用外部文件
  • 自动化托管文档到Readthedocs
• 2.Jupyter Notebook案例
• 3.DEMO PROJECT API
  • demo_project package
    • Subpackages
      • demo_project.tools package
    • Submodules
    • demo_project.say module
    • demo_project.some_action module
    • Module contents
• 4.代码规范
  • 命名
  • 注释
  • TODO注释
• 5.文档规范
  • README
  • 模型及方法论证
  • 性能测试及案例
  • Review记录
• 6. code review方案细则
  • 流程
  • 评分方法
    • 单元测试
    • 代码规范
    • 文档规范
    • 进度完成
    • 跟进情况
  • 评分结果记录
  • 绩效考核
• Sphinx-DEMO
  • 安装Sphinx
  • DEMO项目案例
  • 初始化Sphinx
  • 生成项目模块文档的HTML文件
  • 修改主题
  • Markdown支持
  • Jupyter Notebook支持

Indices and tables

• Index
• Module Index
• Search Page