Sphinx和reStructureText手册
latest
全部章节目录
1. Sphinx和reStructureText手册
1.1. 如何使用
1.1.1. 文件目录说明
1.1.2. 前提
1.1.3. 创建html
1.1.4. 创建pdf
1.1.5. 创建html和pdf
1.1.6. 清空_build文件夹
1.2. License
1.3. Reference
2. sphinx介绍
2.1. 基本介绍
2.2. 安装
2.2.1. Linux
2.2.1.1. Debian/Ubuntu
2.2.1.2. RHEL, CentOS
2.2.2. PyPI
2.2.3. 源码安装
2.3. 与其他标记语言互相转换
2.4. 快速开始
3. sphinx配置
3.1. 项目信息
3.2. 一般配置项
3.2.1. extensions
3.2.2. source_suffix
3.2.3. source_encoding
3.2.4. source_parsers
3.2.5. master_doc
3.2.6. exclude_patterns
3.2.7. templates_path
3.2.8. rst_epilog
3.2.9. rst_prolog
3.2.10. primary_domain
3.2.11. default_role
3.2.12. keep_warnings
3.2.13. suppress_warnings
3.2.14. needs_sphinx
3.2.15. needs_extensions
3.2.16. manpages_url
3.2.17. numfig
3.2.18. numfig_format
3.2.19. numfig_secnum_depth
3.2.20. smartquotes
3.2.21. smartquotes_action
3.2.22. smartquotes_excludes
3.2.23. tls_verify
3.2.24. tls_cacerts
3.2.25. highlight_language
3.2.26. highlight_options
3.2.27. pygments_style
3.2.28. add_function_parentheses
3.2.29. add_module_names
3.2.30. show_authors
3.2.31. modindex_common_prefix
3.2.32. trim_footnote_reference_space
3.2.33. trim_doctest_flags
3.3. 国际化选项
3.3.1. locale_dirs
3.3.2. gettext_compact
3.3.3. gettext_uuid
3.3.4. gettext_location
3.3.5. gettext_auto_build
3.3.6. gettext_additional_targets
3.3.7. figure_language_filename
3.4. 数学选项
3.5. HTML输出选项
3.5.1. html主题html_theme
3.5.2. html_theme_options
3.5.3. html_theme_path
3.5.4. html_style
3.5.5. html_title
3.5.6. html_baseurl
3.5.7. html_logo
3.5.8. html_favicon
3.5.9. html_css_files
3.5.10. html_js_files
3.5.11. html_static_path
3.5.12. html_extra_path
3.5.13. html_last_updated_fmt
3.5.14. html_use_smartypants
3.5.15. html_add_permalinks
3.5.16. html_sidebars
3.5.17. html_additional_pages
3.5.18. html_domain_indices
3.5.19. html_use_index
3.5.20. html_split_index
3.5.21. html_copy_source
3.5.22. html_show_sourcelink
3.5.23. html_sourcelink_suffix
3.5.24. html_use_opensearch
3.5.25. html_file_suffix
3.5.26. html_link_suffix
3.5.27. html_show_copyright
3.5.28. html_show_sphinx
3.5.29. html_output_encoding
3.5.30. html_compact_lists
3.5.31. html_secnumber_suffix
3.5.32. html_search_language
3.5.33. html_search_options
3.5.34. html_search_scorer
3.5.35. html_scaled_image_link
3.5.36. html_math_renderer
3.5.37. singlehtml_sidebars
3.5.38. htmlhelp_basename
3.5.39. htmlhelp_file_suffix
3.5.40. htmlhelp_link_suffix
3.6. EPUB输出配置项
3.7. LaTeX输出配置项
3.8. 文本输出选项
3.8.1. text_newlines
3.8.2. text_sectionchars
3.8.3. text_add_secnumbers
3.8.4. text_secnumber_suffix
3.9. HTML主题
3.9.1. 使用（配置）主题
3.9.1.1. 使用内置主题
3.9.1.2. 使用自定义主题
3.9.1.3. python包主题
3.9.2. 内置主题
3.9.2.1. basic
3.9.2.2. alabaster
3.9.2.3. classic
3.9.2.4. sphinxdoc
3.9.2.5. scrolls
3.9.2.6. agogo
3.9.2.7. nature
3.9.2.8. pyramid
3.9.2.9. haiku
3.9.2.10. traditional
3.9.2.11. epub
3.9.2.12. bizstyle
3.9.3. 第三方主题
3.9.3.1. sphinx_rtd_theme
3.10. Markdown支持
3.11. HTML模板
3.12. sphinx扩展ext
3.12.1. 内置扩展
3.12.2. 外部扩展
3.13. 配置文件示例
4. reStructureText语法
4.1. 内联标记 Inline Markup
4.2. 反斜杠转义 Escaping with Backslashes
4.3. 章节标记 Section Structure
4.4. 段落 Paragraphs
4.5. 无序列表 Bullet Lists
4.6. 有序列表 Enumerated Lists
4.7. 定义列表Definition Lists
4.8. 字段列表 Field Lists
4.9. 参数(选项)列表 Option Lists
4.10. 文字块 Literal Blocks
4.11. 行块 Line Blocks
4.12. 块引用 Block Quotes
4.13. 文档测试块 Doctest Blocks
4.14. 表格 Tables
4.14.1. 网格表格
4.14.2. 简单表格
4.14.2.1. 包含表头的简单表格
4.14.2.2. 无表头的简单表格
4.14.2.3. 跨列合并
4.14.2.4. 单个表格中可以多行
4.15. Transitions
4.16. 脚注 Footnotes
4.17. 引用Citations
4.18. 超链接Hyperlink Targets
4.18.1. 外部链接 External Hyperlink Targets
4.18.2. 锚点链接 Internal Hyperlink Targets
4.18.3. 间接链接 Indirect Hyperlink Targets
4.18.4. Implicit Hyperlink Targets
4.19. 扩展指令 Directives
4.19.1. 警告信息Admonitions
4.19.1.1. 特定的警告信息
4.19.1.2. 通用警告信息Generic Admonition
4.19.2. 图片Images
4.19.3. 页面元素Body Elements
4.19.4. 表格Tables
4.19.5. 文档Documents
4.19.6. References
4.19.7. HTML-Specific
4.19.8. Substitution Definitions
4.19.9. 其他
4.19.10. 通用指令选项参数
4.20. Substitution References and Definitions
4.21. Comments
5. Reference
5.1. 编辑工具
5.2. 参考内容
5.2.1. sphinx
5.2.2. reStructureText
6. Pygments
Sphinx和reStructureText手册
6.
Pygments
在 GitHub 上编辑
6.
Pygments