Closed emptymalei closed 9 years ago
几个注意事项:
自动 index 的语法是
:index:`需要 index 的内容`
但是我觉得这个 inline 的不好用。所以建议使用 block level 的
.. index:: 索引的题目
需要注意的是,这个需要前后空行,并且 :: 和 索引的题目之间需要添加空格。不过允许如下方式来同事对相同的地方索引两个不同的名字:
::
索引的题目
.. index:: 词条1 .. index:: 词条2
即,两个 .. index:: XXX之间允许忽略空格。 详情见这里:http://sphinx-doc.org/markup/misc.html#directive-index
.. index:: XXX
几个注意事项:
自动 index 的语法是
但是我觉得这个 inline 的不好用。所以建议使用 block level 的
需要注意的是,这个需要前后空行,并且
::
和索引的题目
之间需要添加空格。不过允许如下方式来同事对相同的地方索引两个不同的名字:即,两个
.. index:: XXX
之间允许忽略空格。 详情见这里:http://sphinx-doc.org/markup/misc.html#directive-index