pdoc项目增强:支持HTML标题在目录中的自动识别
2025-07-04 12:31:01作者:侯霆垣
在文档生成工具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标题
}
这一改进具有以下技术优势:
- 保持与现有markdown2功能的兼容性
- 无需增加新的命令行参数,符合项目保持简洁接口的设计理念
- 对使用者完全透明,不改变现有工作流程
- 解决了混合格式文档的目录生成问题
对于文档编写者而言,这意味着可以更灵活地组织文档内容:
- 可以直接引入包含HTML标题的外部文档片段
- 支持历史遗留的混合格式文档
- 保持生成的目录结构完整性
该改进已被项目维护者采纳并合并,体现了pdoc项目对实用性和兼容性的持续优化。对于需要处理复杂文档结构的Python项目,这一增强显著提升了文档工具的适应能力。
登录后查看全文
热门项目推荐
相关项目推荐
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00- QQwen3-Coder-Next2026年2月4日,正式发布的Qwen3-Coder-Next,一款专为编码智能体和本地开发场景设计的开源语言模型。Python00
xw-cli实现国产算力大模型零门槛部署,一键跑通 Qwen、GLM-4.7、Minimax-2.1、DeepSeek-OCR 等模型Go06
PaddleOCR-VL-1.5PaddleOCR-VL-1.5 是 PaddleOCR-VL 的新一代进阶模型,在 OmniDocBench v1.5 上实现了 94.5% 的全新 state-of-the-art 准确率。 为了严格评估模型在真实物理畸变下的鲁棒性——包括扫描伪影、倾斜、扭曲、屏幕拍摄和光照变化——我们提出了 Real5-OmniDocBench 基准测试集。实验结果表明,该增强模型在新构建的基准测试集上达到了 SOTA 性能。此外,我们通过整合印章识别和文本检测识别(text spotting)任务扩展了模型的能力,同时保持 0.9B 的超紧凑 VLM 规模,具备高效率特性。Python00
KuiklyUI基于KMP技术的高性能、全平台开发框架,具备统一代码库、极致易用性和动态灵活性。 Provide a high-performance, full-platform development framework with unified codebase, ultimate ease of use, and dynamic flexibility. 注意:本仓库为Github仓库镜像,PR或Issue请移步至Github发起,感谢支持!Kotlin08
VLOOKVLOOK™ 是优雅好用的 Typora/Markdown 主题包和增强插件。 VLOOK™ is an elegant and practical THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown.Less00
热门内容推荐
最新内容推荐
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
531
3.74 K
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
336
178
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
886
596
Ascend Extension for PyTorch
Python
340
403
暂无简介
Dart
772
191
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
openJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力
TSX
986
247
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
416
4.21 K
React Native鸿蒙化仓库
JavaScript
303
355