Repository navigation
MAINT Separate strict HTML and checked PDF documentation builds - #3067
Open
Roman Lutz (romanlutz) wants to merge 1 commit into
Open
Roman Lutz (romanlutz) wants to merge 1 commit into
Roman Lutz (romanlutz) wants to merge 1 commit into
Conversation
Correct the Commons attribution and remove unsupported grid options. Keep API preparation and RSS generation while making HTML independent of LaTeX and verifying PDF prerequisites, fresh output, and native logs. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
This branch has not been deployed
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
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.
Description
Strict documentation builds fail on a Wikipedia media-viewer fragment in the ship-photo citation. Separately,
--all --htmlalso selects the configured PDF export, so an HTML build can attempt LaTeX and report a missingbook.logwhen the toolchain is unavailable.:gutter: 3options. The current MyST renderer already ignores them, so this removes warnings without changing card spacing, columns, or order.docs-buildgenerate the API reference and run strict HTML without--all, while preserving RSS generation. Adddocs-build-pdfand sequence HTML before PDF indocs-build-all.--sitewith--pdf --strictbecause the locked Jupyter Book version applies strict document-error checking to site processing, not standalone exports.Strictness is preserved and warnings are not globally suppressed. Hosted CI, publishing settings, dependency versions, and landing-page video behavior are unchanged. Contributors who previously relied on
make docs-buildimplicitly attempting PDF export should usemake docs-build-pdformake docs-build-all.Tests and Documentation
Documented uv preparation, independent HTML/PDF commands, PDF prerequisites, and output acceptance checks in the notebook contribution guide. Added helper and build-contract regressions alongside existing documentation structure, workflow, and video-player tests.
Commands run from the repository root unless noted:
Verified the corrected citation and photographer credit in rendered HTML, preserved landing-player assets, and unchanged notebook code, outputs, and metadata. Strict HTML still reports existing warnings; success is not a claim of warning-free documentation. Commit hooks passed.
Actual PDF compilation and PDF content/layout inspection were not run because
latexmkandxelatexare unavailable. Synthetic PDFs in unit tests validate the helper's checks, not the real book export. Real PDF acceptance still requires an equipped environment.JupyText was used to check paired cell consistency, but notebook execution was not run. No live notebook/provider calls were made.