sphinxcontrib-getstart-sphinx 1.2.0

用法

要启用此软件包中的所有扩展，请将 sphinxcontrib.getstart_sphinx 添加到您的 extensions 列表中的 conf.py。

extensions = ['sphinxcontrib.getstart_sphinx']

如果您想分别启用特定扩展，请将其名称添加到列表中，如下所示：

extensions = ['sphinxcontrib.getstart_sphinx.better_docref',
              'sphinxcontrib.getstart_sphinx.footnote_relocator']

指令

您可以使用以下指令：

column

一个标记列的指令。它接受列标题作为参数，并且接受列体作为内容块。

示例

.. column:: SphinxとPythonのバージョンの関係

   バージョン1.5以降、Sphinxを動作させるには2.7もしくは3.4以上の
   Pythonが必要です。
   そのため、古いPythonがインストールされるCentOS 6.x系などのディスト
   リビューションでは、最新のSphinxが利用できません。

设置

您可以配置以下设置以安排扩展的行为。

section_numbers:

一个将文档名映射到章节编号文本的字典。这由 better_docref 扩展用于为文档引用构建链接标题。

示例

section_numbers = {
    'ch01': '第1章',
    'ch02': '第2章',
    'ch03': '第3章',
    'ch04': '第4章',
    'ch05': '第5章',
    'ch06': '第6章',
    'appendix/references': '付録A',
    'appendix/builders': '付録B',
    'appendix/quickstart': '付録C',
    'appendix/texlive': '付録D',
    'appendix/make_sh': '付録E',
    'appendix/markdown': '付録F',
    'appendix/community': '付録G',
}