Repository navigation
Docs site: render the generated reference pages (follow-up to #48) - #49
Merged
Merged
Conversation
…dered pages gen-doc wraps each page body in <div markdown="1">, which Python-Markdown only parses with md_in_html, so everything after the diagram was left as raw text. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
jdkent
marked this pull request as ready for review
October 21, 2026 02:18
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.
The reference pages on the published site show their body as raw Markdown after the diagram (the URI line, the property and slot tables, the slot links).
Cause. gen-doc wraps each page body in
<div data-search-exclude markdown="1">. Python-Markdown parses inside an HTML block only with themd_in_htmlextension, which the config lacked, so everything after the opening<div>stayed raw text.Fix. Enable
md_in_htmlandattr_listinmkdocs.yml. No generated Markdown is post-processed; the mermaid custom fence and diagrams are unchanged.Guard.
tools/check_site.pyfails if any built page contains| --- |or](outside<pre>/<code>;docs.ymlruns it aftermkdocs build --strict. With the extensions reverted it reports 1132 of 1146 pages unrendered (and exits 1); with them, 0. Rendered Study (storage) has 3 tables, the Class Properties, Slots, Mappings and LinkML Source headings, one mermaid diagram and a linked URI. The check covers every class, enum and slot page of the storage, extraction and paper-parse schemas.#48 was merged before this fix could be pushed to it, so this is a separate PR.
🤖 Generated with Claude Code