如何用Sphinx RTD和AutoAPI启用完全展开的面包屑?

问题描述 投票:0回答:1

我正在试验用Sphinx RTD和AutoAPI来实现完全展开的面包屑。Sphinx AutoAPI 以使文档更易维护。它做得很好,除了一件事:面包屑。

在AutoAPI生成的文档中,面包屑并没有像我期望的那样工作。我们没有在每个深度添加一个链接项,而是得到 "Docs >>",然后是一个单一的链接项。

这是一个可用性的问题,因为你不能在点击到一个子项目后导航到一个父项目。

picture of breadcrumbs not working

注意:我使用的是 sphinx_rtd_theme,有一个自定义的 extrabody 块的头。

我一直找不到任何关于面包屑的文档。sphinx_rtd_theme.

在深入研究源码之前,我想问一下是否有人曾经见过这个问题。谢谢!

PS:你可以在这里看到这项工作的PR草案。https:/github.comgreat-expectationsgreat_expectationspull1582。

python-sphinx breadcrumbs read-the-docs
1个回答
0
投票

感谢Steve Piercy从Pyramid项目中提供的有用的建议!我在Pyramid项目的最后添加了以下几行。

我在我的 index.rst 来激活面包屑。

.. toctree::
   :maxdepth: 2

   autoapi/index

面包屑链接的格式仍然是内联代码,所以我把我的 _static/style.css 这样的文件。

ul.wy-breadcrumbs li code span.pre{
  font-size: 16px;
  font-family: HKGroteskPro, serif;
  font-weight: 400;
  color: rgb(155, 89, 182);
}

这样的造型并不完美,但足够接近,不会让人觉得突兀。

© www.soinside.com 2019 - 2024. All rights reserved.