Fail closed when pages.docs_dir, title, or extra_links are mistyped - #111
Merged
Merged
Conversation
YAML lists for pages.docs_dir Path-joined (TypeError) or interpolated into HTML as bracketed strings. extra_links and pages.segments rows only failed at generate. Require those keys at config load. Co-authored-by: jmjava <jmjava@gmail.com>
ruff, pytest (652 passed, 1 skipped), and docgen benchmark are green. Co-authored-by: jmjava <jmjava@gmail.com>
jmjava
marked this pull request as ready for review
September 7, 2026 21:23
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.
Summary
YAML lists for
pages.docs_dir/demos_subdirPath-joined when writingindex.html(Path / listTypeError).pages.title/subtitle/repo_urlandpages.segments.<id>.titlewere interpolated into HTML as"['Demo Videos']".pages.extra_linksitems and non-mappingpages.segmentsrows only failed at generate (RuntimeError).This PR requires those keys at
Config.from_yaml. Emptytitle/subtitle/repo_urlremain allowed.extra_linksmust be a list of mappings with a non-emptyhrefstring.Test plan
ruff check src/ tests/pytest tests/— 652 passed, 1 skippeddocgen benchmarkvssrc/docgen/benchmark_data/baseline.json(quality average 100.0)Milestone
milestones/pages-config-strings.md