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项目,这一增强显著提升了文档工具的适应能力。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0190
cann-learning-hubCANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。Jupyter Notebook0113
Step-3.7-FlashStep-3.7-Flash是一个拥有 1980 亿参数的稀疏混合专家(MoE)视觉语言模型,由 1960 亿参数的语言主干网络和 18 亿参数的视觉编码器组合而成,具备原生图像理解能力。Python00
JoyAI-EchoJoyAI-Echo,这是一个独立的、仅用于推理的版本,旨在实现分钟级多镜头音视频生成。它采用了经过蒸馏的DMD生成器、配对的跨模态记忆以及故事级别的一致性。其性能的核心在于,一个跨模态视听记忆库能够在长达五分钟的视频中保持角色外观和语音音色的一致性。同时,一个训练后处理流程将基于记忆的强化学习与分布匹配蒸馏相结合,实现了7.5倍的速度提升,显著增强了视觉质量和对齐效果。00
omega-aiOmega-AI:基于java打造的深度学习框架,帮助你快速搭建神经网络,实现模型推理与训练,引擎支持自动求导,多线程与GPU运算,GPU支持CUDA,CUDNN。Java04
llm-universe本项目是一个面向小白开发者的大模型应用开发教程,在线阅读地址:https://datawhalechina.github.io/llm-universe/Jupyter Notebook08
热门内容推荐
最新内容推荐
项目优选
收起
deepin linux kernel
C
32
16
暂无描述
Dockerfile
762
4.95 K
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
1.8 K
190
Fflutter_flutter
暂无简介
Dart
1 K
260
Ascend Extension for PyTorch
Python
717
869
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。
C++
854
1.91 K
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1.07 K
1.09 K
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.73 K
1.02 K
本项目是CANN提供的神经网络类计算算子库,实现网络在NPU上加速计算。
C++
676
1.32 K
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
455
438