主页

索引

模块索引

搜索页面

3.1. Sphinx文档

作者:

新溪-gordon <programfan.info#gmail.com>

时间:

2012-01-30

Contents:

• 3.1.1. 基本格式
  • 基本
  • sidebar侧边栏
  • 引用,链接,图片
  • 图片
  • video视频
  • 文件包含
  • 代码
  • 颜色
  • 通知
  • 树显示
  • 表格相关
  • 替换
  • 其他
• 3.1.2. 高级格式
  • meta
  • Domains
  • role
  • raw标签
  • 数学相关
  • github&gist
  • 符号
• 3.1.3. conf.py配置文件
• 3.1.4. [主]文件使用实例
  • various domain-specific languages
  • 语言
  • 配置文件configuration file formats
  • CSS相关
• 3.1.5. sphinx主题
  • 通用
  • sphinx_rtd_theme主题
• 3.1.6. sphinx扩展
  • 数学符号
  • PlantUML插件
  • graphviz 插件
  • recommonmark
  • Extends literalinclude to include URLs
  • sphinx-git
  • nbsphinx-适用于.ipynb文件
  • sphinx-copybutton
  • Sphinx-Gallery
  • other
• 3.1.7. 支持高亮的语言列表
• 3.1.8. sphinx安装与使用核心命令
• 3.1.9. 搜索
  • 中文搜索
• 3.1.10. 常见问题
  • cannot import name ‘environmentfilter’ from ‘jinja2’
  • ImportError: cannot import name ‘soft_unicode’ from ‘markupsafe’

• 官网: https://www.sphinx-doc.org/en/master/

• 扩展: https://www.sphinx-doc.org/en/master/usage/extensions/index.html

• 其他开发: https://www.sphinx-doc.org/en/master/develop.html

主页

索引

模块索引

搜索页面