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

如何解决如何使 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 服务”我的网站时,我希望任何在侧边菜单中有层次结构的东西都是可折叠的,就像在这个例子中一样(注意左侧边栏上的折叠/展开图标):

This is the ideal

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

My attempt

应该注意的是,我想,在我的情况下,'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 文件?

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

谢谢!

解决方法

也许,您只需要以不同的方式编写它。这就是它在我的项目中的工作方式:

nav:
  - 'index.md'
  - 'glossary.md'
  - 'Subject1':
    - 'dir/file1.md'
    - 'dir/file2.md'
  - 'Subject2':
    - 'NestedSubject2_1':
      - 'dir/file1.md'
      - 'dir/file2.md'
    - 'NestedSubject2_2':
      - 'dir/file.md'
      - 'dir/file2.md'
      - 'dir/file3.md'
      - 'dir/file4.md'

这是我至少可以展示的,抱歉。这就是我的项目的结构。

How the project looks like

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


依赖报错 idea导入项目后依赖报错,解决方案:https://blog.csdn.net/weixin_42420249/article/details/81191861 依赖版本报错:更换其他版本 无法下载依赖可参考:https://blog.csdn.net/weixin_42628809/a
错误1:代码生成器依赖和mybatis依赖冲突 启动项目时报错如下 2021-12-03 13:33:33.927 ERROR 7228 [ main] o.s.b.d.LoggingFailureAnalysisReporter : *************************** APPL
错误1:gradle项目控制台输出为乱码 # 解决方案:https://blog.csdn.net/weixin_43501566/article/details/112482302 # 在gradle-wrapper.properties 添加以下内容 org.gradle.jvmargs=-Df
错误还原:在查询的过程中,传入的workType为0时,该条件不起作用 <select id="xxx"> SELECT di.id, di.name, di.work_type, di.updated... <where> <if test=&qu
报错如下,gcc版本太低 ^ server.c:5346:31: 错误:‘struct redisServer’没有名为‘server_cpulist’的成员 redisSetCpuAffinity(server.server_cpulist); ^ server.c: 在函数‘hasActiveC
解决方案1 1、改项目中.idea/workspace.xml配置文件,增加dynamic.classpath参数 2、搜索PropertiesComponent,添加如下 <property name="dynamic.classpath" value="tru
删除根组件app.vue中的默认代码后报错:Module Error (from ./node_modules/eslint-loader/index.js): 解决方案:关闭ESlint代码检测,在项目根目录创建vue.config.js,在文件中添加 module.exports = { lin
查看spark默认的python版本 [root@master day27]# pyspark /home/software/spark-2.3.4-bin-hadoop2.7/conf/spark-env.sh: line 2: /usr/local/hadoop/bin/hadoop: No s
使用本地python环境可以成功执行 import pandas as pd import matplotlib.pyplot as plt # 设置字体 plt.rcParams['font.sans-serif'] = ['SimHei'] # 能正确显示负号 p
错误1:Request method ‘DELETE‘ not supported 错误还原:controller层有一个接口,访问该接口时报错:Request method ‘DELETE‘ not supported 错误原因:没有接收到前端传入的参数,修改为如下 参考 错误2:cannot r
错误1:启动docker镜像时报错:Error response from daemon: driver failed programming external connectivity on endpoint quirky_allen 解决方法:重启docker -> systemctl r
错误1:private field ‘xxx‘ is never assigned 按Altʾnter快捷键,选择第2项 参考:https://blog.csdn.net/shi_hong_fei_hei/article/details/88814070 错误2:启动时报错,不能找到主启动类 #
报错如下,通过源不能下载,最后警告pip需升级版本 Requirement already satisfied: pip in c:\users\ychen\appdata\local\programs\python\python310\lib\site-packages (22.0.4) Coll
错误1:maven打包报错 错误还原:使用maven打包项目时报错如下 [ERROR] Failed to execute goal org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources (default-resources)
错误1:服务调用时报错 服务消费者模块assess通过openFeign调用服务提供者模块hires 如下为服务提供者模块hires的控制层接口 @RestController @RequestMapping("/hires") public class FeignControl
错误1:运行项目后报如下错误 解决方案 报错2:Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.8.1:compile (default-compile) on project sb 解决方案:在pom.
参考 错误原因 过滤器或拦截器在生效时,redisTemplate还没有注入 解决方案:在注入容器时就生效 @Component //项目运行时就注入Spring容器 public class RedisBean { @Resource private RedisTemplate<String
使用vite构建项目报错 C:\Users\ychen\work>npm init @vitejs/app @vitejs/create-app is deprecated, use npm init vite instead C:\Users\ychen\AppData\Local\npm-