docs(build): render English and .dot SVGs into build/, keep docs/src clean#4110
Open
grandixximo wants to merge 2 commits into
Open
docs(build): render English and .dot SVGs into build/, keep docs/src clean#4110grandixximo wants to merge 2 commits into
grandixximo wants to merge 2 commits into
Conversation
Per review (BsAtHome): generated files should not live in the source tree. The English docs now render from build/adoc/en, the same model the translations already use, instead of from docs/src. - Stage the English .adoc + images + code fixtures (e.g. panelui_handler.py) into build/adoc/en via a find|tar copy (no rsync dependency). - Generate components_gen.adoc straight into build/adoc/en/hal and point its po4a master there (po4a.cfg only; msgids unchanged, so no pot/po churn). - Repoint the English HTML and PDF rules, the html-copy step, and the dependency extractor at build/adoc/en. docs/src no longer accumulates components_gen.adoc or per-topic .html; docs/.gitignore drops those entries. The .dot-rendered SVGs are still generated in src/code and staged across (a follow-on moves their generation into build too). Validated with a full English htmldocs build (585 pages, no include errors). PDF and translated builds still to be verified.
The .dot diagrams under docs/src/code/ rendered their SVGs beside the sources; route them into build/adoc/en/<topic> instead, so docs/src holds no generated artifacts. The translated image-copy steps source images from src, so fall back to the English build tree for the generated SVGs. Drops the six src/code/*.svg entries from docs/.gitignore.
grandixximo
force-pushed
the
docs/render-en-from-build
branch
from
dd6d9c9 to
c99d73c
Compare
Contributor
|
This might accumulate some conflicts when #4109 gets merged. Just thinking out loud... |
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.
Follow-up to #4081, applying the principle that nothing generated should live in the source tree (Bertho's gitignore review).
components_gen.adoc(the auto-generated HAL component list) now renders intobuild/adoc/en/and the English build reads it from there, instead of writing intodocs/src/hal/..dotsources now land inbuild/instead ofdocs/src/code/.No output changes; only the generated files move out of the source tree.