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项目,这一增强显著提升了文档工具的适应能力。
登录后查看全文
热门项目推荐
相关项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C0102
baihu-dataset异构数据集“白虎”正式开源——首批开放10w+条真实机器人动作数据,构建具身智能标准化训练基座。00
mindquantumMindQuantum is a general software library supporting the development of applications for quantum computation.Python059
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
AgentCPM-Explore没有万亿参数的算力堆砌,没有百万级数据的暴力灌入,清华大学自然语言处理实验室、中国人民大学、面壁智能与 OpenBMB 开源社区联合研发的 AgentCPM-Explore 智能体模型基于仅 4B 参数的模型,在深度探索类任务上取得同尺寸模型 SOTA、越级赶上甚至超越 8B 级 SOTA 模型、比肩部分 30B 级以上和闭源大模型的效果,真正让大模型的长程任务处理能力有望部署于端侧。Jinja00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
478
3.57 K
React Native鸿蒙化仓库
JavaScript
288
340
暂无简介
Dart
729
175
Ascend Extension for PyTorch
Python
288
321
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
850
448
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
239
100
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
TorchAir 支持用户基于PyTorch框架和torch_npu插件在昇腾NPU上使用图模式进行推理。
Python
452
180
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.28 K
705