首页
/ pdoc项目增强:支持HTML标题在目录中的自动识别

pdoc项目增强:支持HTML标题在目录中的自动识别

2025-07-04 06:54:13作者:侯霆垣

在文档生成工具pdoc的使用过程中,开发者发现当文档字符串包含HTML标题标签(如<h1>)时,这些标题无法被自动识别并包含在生成的目录(ToC)中。这种情况常见于通过.. include::指令引入的外部HTML文件或混合使用Markdown与HTML标题的文档场景。

pdoc底层依赖的markdown2库其实已经提供了相关功能支持。具体而言,通过启用header-ids扩展的mixed模式,即可实现对HTML标题的自动识别和ID生成。这一功能在markdown2的更新中已经实现,但pdoc尚未默认启用该配置。

技术实现上,只需要在pdoc的渲染配置中简单调整header-ids参数即可:

"header-ids": {
    "mixed": True  # 启用混合模式识别HTML标题
}

这一改进具有以下技术优势:

  1. 保持与现有markdown2功能的兼容性
  2. 无需增加新的命令行参数,符合项目保持简洁接口的设计理念
  3. 对使用者完全透明,不改变现有工作流程
  4. 解决了混合格式文档的目录生成问题

对于文档编写者而言,这意味着可以更灵活地组织文档内容:

  • 可以直接引入包含HTML标题的外部文档片段
  • 支持历史遗留的混合格式文档
  • 保持生成的目录结构完整性

该改进已被项目维护者采纳并合并,体现了pdoc项目对实用性和兼容性的持续优化。对于需要处理复杂文档结构的Python项目,这一增强显著提升了文档工具的适应能力。

登录后查看全文
热门项目推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
179
263
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
869
514
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
130
183
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
295
331
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
333
1.09 K
harmony-utilsharmony-utils
harmony-utils 一款功能丰富且极易上手的HarmonyOS工具库,借助众多实用工具类,致力于助力开发者迅速构建鸿蒙应用。其封装的工具涵盖了APP、设备、屏幕、授权、通知、线程间通信、弹框、吐司、生物认证、用户首选项、拍照、相册、扫码、文件、日志,异常捕获、字符、字符串、数字、集合、日期、随机、base64、加密、解密、JSON等一系列的功能和操作,能够满足各种不同的开发需求。
ArkTS
18
0
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.08 K
0
kernelkernel
deepin linux kernel
C
22
5
WxJavaWxJava
微信开发 Java SDK,支持微信支付、开放平台、公众号、视频号、企业微信、小程序等的后端开发,记得关注公众号及时接受版本更新信息,以及加入微信群进行深入讨论
Java
829
22
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
601
58