Skip to content

docs: add PDF heading levels guide - #4042

Merged
dolfim-ibm merged 2 commits into
docling-project:mainfrom
DanielNg0729:docs/pdf-heading-levels
Aug 24, 2026
Merged

dolfim-ibm merged 2 commits into
docling-project:mainfrom
DanielNg0729:docs/pdf-heading-levels

Conversation

@DanielNg0729

Copy link
Copy Markdown
Member

Hi maintainers, The PDF heading-level inference shipped across #3633, #3688 and #3984 but was never fully documented. This
PR adds that documentation. No library code is touched.

  • docs/usage/heading_levels.md (new) — guide: how to enable it, the bookmark / numbering /
    font-style signals and their precedence, the option table, and the generate_parsed_pages
    requirement of the style fallback.
  • docs/examples/heading_levels.py (new) — runnable example printing the recovered hierarchy.
  • docs/usage/advanced_options.md, docs/index.md, README.md, mkdocs.yml — pointers and nav.
  • docling/.agents/skills/docling/references/python-sdk.md — heading_hierarchy_options added to
    the options table.

Every snippet and level sequence in the guide was executed against this branch. zensical build
adds no new warnings and prek passes on the changeset.

Checklist:

  • Documentation has been updated, if necessary.
  • Examples have been added, if necessary.
  • Tests have been added, if necessary. (documentation only)

Add a usage guide and a runnable example for the section-header level
inference shipped in docling-project#3633, docling-project#3688 and docling-project#3984, covering the bookmark, numbering
and font-style signals, their precedence, and the generate_parsed_pages
requirement of the style fallback.

Signed-off-by: Daniel Nguyen <danielnguyenh07@gmail.com>
@github-actions

Copy link
Copy Markdown
Contributor

✅ DCO Check Passed

Thanks @DanielNg0729, all your commits are properly signed off. 🎉

@mergify

mergify Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Merge Protections

🟢 Merge protection satisfied — ready to merge.

Show 1 satisfied protection

🟢 Enforce conventional commit

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert)(?:\(.+\))?(!)?:

Removed PDF heading recovery feature from the list.

Signed-off-by: Nguyen Hoang Duong <danielnguyenh07@gmail.com>
@codecov

codecov Bot commented Aug 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@dolfim-ibm dolfim-ibm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@dolfim-ibm
dolfim-ibm merged commit b0e4977 into docling-project:main Aug 24, 2026
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants