Sphinx/reST 没有为文档生成索引

发布于 2024-12-16 13:51:02 字数 66 浏览 4 评论 0原文

使用ma​​ke html命令生成文档时,索引页始终为空。我需要为此启用任何功能吗?

The index page is always empty when the document is generated using make html command. Do i need to do enable anything for this?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

捎一片雪花 2024-12-23 13:51:02

来自 http://people.ee.ethz.ch /~creller/web/tricks/reST.html#sphinx-directives

索引中的条目是根据所有信息自动创建的
单元(如函数、类或属性)。显式手动输入
制成为:

..索引::<关键字1>,<关键字2>,...

..索引::单个:<关键字>; <子关键字>

..索引::对:<关键字第一部分>; <关键字第二部分>第一部分
两个版本创建单个(子)条目,而最后一个版本
创建两个条目“<关键字第一部分>; <关键字第二部分>”和
“<关键字第二部分>; <关键字第一部分>”。

From http://people.ee.ethz.ch/~creller/web/tricks/reST.html#sphinx-directives:

Entries in the index are created automatically from all information
units (like functions, classes or attributes). Explicit manual entries
are made as:

.. index:: ‹keyword 1›, ‹keyword 2›, ...

.. index:: single: ‹keyword›; ‹sub-keyword›

.. index:: pair: ‹keyword 1st part›; ‹keyword 2nd part› The first
two versions create single (sub-)entries, while the last version
creates two entries “‹keyword 1st part›; ‹keyword 2nd part›” and
“‹keyword 2nd part›; ‹keyword 1st part›”.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文