如何使 MkDocs 侧边菜单中的页面可展开？

问题描述

我尝试搜索此问题，但无法获得任何指向解决方案的答案。让我先从一些背景开始吧。

我的目标：

我目前正在研究如何为某个 python 脚本存储库创建一个体面的自动化文档。它是一个图书馆，所以本身不是一个“项目”。它也有自己的位置，因为它不是由独立的 Python 安装维护，而是由 Autodesk Maya 附带的 Python 2.7 实现维护。因此，库中有一堆模块，按照对我们有意义的方式进行组织，并且所有函数都有一个根据 reStructuredText（:param parameterName: Description 等）编写的文档字符串。我正在寻找可以清理整个存储库的东西，并创建一个漂亮的 html 文档，该文档看起来很整洁，并且可以轻松搜索现有功能，认为它必须存在，但是唉，我找不到任何东西用户友好。

我尝试了什么：

Sphinx、pdoc3 - 两者都证明了不同程度的不理想。

我决定做什么：

我最后一次尝试的是 mkdocs。这看起来相当简单，不仅因为它实际上并没有做任何事情，而是创建了一个页面的存根，该存根基于用户必须提供的一个 .yaml 配置文件和每页 .md 文件来填充。 仅供参考，我对 yaml 和 md 都不熟悉，因为我从来没有使用过。我决定为自己创建一个包装器（用于一键生成文档功能），它基本上可以通过我的 Python 库运行，为每个模块创建一个 .md 页面，并用函数/类及其文档字符串填充它。我必须自己解析文档字符串，但这没什么大不了的。这基本上会将 mkdocs 变成一个相当不错的自动化文档，无需手动输入。现在......我确实喜欢你可以在 yaml 配置文件中为你的文档设置的主题 readthedocs，但这就是我被卡住的地方。

我的问题

当我“mkdocs 服务”我的网站时，我希望任何在侧边菜单中有层次结构的东西都是可折叠的，就像在这个例子中一样（注意左侧边栏上的折叠/展开图标）：

但我得到的是没有可折叠性：

应该注意的是，我想，在我的情况下，'attr' 部分是一个 .md 站点，它只有一个简单的结构，每个函数名称都有一个 h3 标头，下面还有一些描述，然后才具有水平从下一个函数中划分的规则。

此外，在 mydocs 结构的 yaml 配置文件中，结构保持非常简单：

site_name: My Repo
nav:
    - Home: 'index.md'
    - 'Modules':
        - attr: 'pageA.md'
        - pageB: 'pageB.md'
        - pageC: 'pageC.md'
    - About: 'about.md'
theme:
    name: readthedocs
    include_homepage_in_sidebar: false
    highlightjs: true
    hijs_languages:
        - python
markdown_extensions:
    - toc:
        permalink: True
        separator: "_"

所以问题是 - 我将如何让我的侧边栏几乎没有展开/折叠图标？（即此时的 attr 站点）可行吗？是否可以通过 yaml 配置文件或每个页面的 .md 文件？

潜在地，是否有更好的替代方案来替代我正在做的事情，不需要我编写自己的文档制作一键式解决方案？

谢谢！

解决方法

暂无找到可以解决该程序问题的有效方法，小编努力寻找整理中！

如果你已经找到好的解决方法，欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@）

mkdocs python