docs(html): deprecate the html config options nothing reads - #700
Merged
Conversation
`HtmlConfig::embed_outline`, `no_drm`, `background_image_format` and `background_image_dpi` are read nowhere in the library: no outline is written, no output carries a restriction to lift, and no view renders a background image to a file. Setting one has done nothing for a while, which the header did not say. Marked deprecated in the header and in the python, wasm, jni and apple bindings that carry them. They keep storing and returning what is set — no caller breaks — so removing them is a later, breaking change. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EPasn1P1Y4xGehbRdWWFwY
andiwand
force-pushed
the
chore/deprecate-inert-html-config
branch
from
August 18, 2026 13:39
c532604 to
7fc4f40
Compare
andiwand
added a commit
that referenced
this pull request
Aug 18, 2026
#700 merged after the v6.8.0 stamp but was written against the file before it, so its entry landed under the v6.8.0 heading — a release the change is not in. The v6.8.0 section now reads as the tag ships it, and the deprecation waits with the rest of the unreleased notes. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012jwYugqjwV6vTLJYRbFgtP
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Four
HtmlConfigoptions are read nowhere in the library:embed_outlineno_drmbackground_image_formatbackground_image_dpigrep -rn 'embed_outline\|no_drm\|background_image' srcfinds only their declarations inhtml.hpp. Setting one has done nothing for a while, which the header did not say. Noticed while surveying which config toggles the reference output covers (#699) — these are the ones there is nothing to cover.Marked
@deprecatedin the header and in the four binding surfaces that carry them: python docstrings, the wasm.d.ts,@Deprecatedon the Java fields, and doc comments on the ObjC properties.They keep storing and returning what is set, and the bindings keep carrying them, so no caller breaks. Removing them is a later, breaking change — the same treatment
GlobalParams::odr_core_data_pathandlibmagic_database_pathalready got.Verified:
bind_html.cppcompiles against pybind11, and the Java package compiles clean under-Xlint:deprecation(nothing in the repo reads the fields from Java).🤖 Generated with Claude Code