换成 Sphinx 工具的任务列表
emptymalei opened this issue · comments
LM commented
- 把所有的内容全部转换到 rst 语法
- 按照 rst 的语法添加 index page,来代替原来的 glossary. (sphinx 也支持 glossary,但是似乎不是特别好用,不如用 index 来代替。)
- 调整主题,添加 global menu
几个注意事项:
-
rst 语法中,标题要求下面的符号的长度要至少跟标题文字长度相同,例如我们的标题使用的是 ---------- 作为标题的表示符号,那么下面的 --------- 的长度要至少跟标题一样长。
-
自动 index 的语法是
:index:`需要 index 的内容`
但是我觉得这个 inline 的不好用。所以建议使用 block level 的
.. index:: 索引的题目
需要注意的是,这个需要前后空行,并且
::
和索引的题目
之间需要添加空格。不过允许如下方式来同事对相同的地方索引两个不同的名字:.. index:: 词条1 .. index:: 词条2
即,两个
.. index:: XXX
之间允许忽略空格。
详情见这里:http://sphinx-doc.org/markup/misc.html#directive-index