docs: generate server options as list-table for stable diffs (backport of #4426 to V6.2) - #4494
Merged
Conversation
reinkrul
requested review from
gerardsn,
stevenvegt and
woutslakhorst
as code owners
September 9, 2026 08:33
Contributor
|
Coverage Impact ⬆️ Merging this pull request will increase total coverage on Modified Files with Diff Coverage (2)
🛟 Help
|
* docs: generate server options as list-table for stable diffs The simple-table format pads every cell to the widest value in its column, so a single new option with a long description rewrites the entire table (as happened in #4420, where 2 new options produced a 142-line diff). A list-table has no cross-row alignment: adding an option is always a 3-line diff. The rendered HTML is identical, verified by diffing Sphinx output of both formats. Also removes a stray debug println from the generator. Assisted-by: AI * build: add docs-docker Makefile target for containerized Sphinx builds The docs/Dockerfile existed but nothing referenced it. The new target builds the documentation without requiring Python/Sphinx on the host. Assisted-by: AI --------- Co-authored-by: Rein Krul <info@reinkrul.nl> (cherry picked from commit e7f8225)
reinkrul
force-pushed
the
backport-4426-v6.2
branch
from
September 9, 2026 09:22
d953116 to
4ef4e3b
Compare
Resolve module path conflicts from the /v6 module rename. Assisted-by: AI
stevenvegt
force-pushed
the
backport-4426-v6.2
branch
from
September 9, 2026 12:49
0c7c1d5 to
24acc07
Compare
This was referenced Sep 9, 2026
stevenvegt
approved these changes
Sep 9, 2026
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
2 participants
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.
Backport of #4426 to V6.2.
Two rounds of conflicts, both in generated/generated-adjacent doc code, resolved without hand-merging content:
docs/pages/deployment/server_options.rst: generated content differs between branches (V6.2 has a different set of server options). Resolved by regenerating viago run ./docs docsrather than merging by hand;server_options_didnuts.rstcame out identical to the auto-merged version, confirming the regeneration is consistent.docs/generate_docs.go: after V6.2 picked up test(docs): fail when generated docs are out of date (backport of #4360 to V6.2) #4493 (backport of test(docs): fail when generated docs are out of date #4360, "fail when generated docs are out of date"), its doc-generation code was refactored to build docs in memory (map[string][]byte) instead of writing files directly, so tests can compare against committed output. Kept that map-based structure and applied only the list-table formatting change from docs: generate server options as list-table for stable diffs #4426 on top of it.Assisted by AI