Skip to content

docs: deduplicate built HTML images into a shared image/ tree #4157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
grandixximo wants to merge 1 commit into
base: master
Choose a base branch
from
+387 −2
Open

docs: deduplicate built HTML images into a shared image/ tree #4157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/src/Submakefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,7 +573,7 @@ $(DOC_OUT_HTML)/pdf/index.html: $(PDF_TARGETS) ../scripts/make-docs-pdf-index
@mkdir -p $(dir $@)
$(Q)../scripts/make-docs-pdf-index

htmldocs: svgs_made_from_dots .htmldoc-stamp checkref_en
htmldocs: svgs_made_from_dots .htmldoc-stamp .dedup-images-stamp checkref_en

# When translations are enabled, the .adoc files in $(L)/ are produced by
# the translateddocs target (po4a). Teach make how to ask for them: the
Expand All @@ -595,6 +595,13 @@ endif
.htmldoc-stamp: .copy-asciidoc-stamp $(DOC_DIR)/.gen_complist-stamp $(HTML_TARGETS) .images-stamp .include-stamp $(DOC_OUT_HTML)/asciidoctor.css $(DOC_OUT_HTML)/rouge-github.css .lang-switcher-stamp
touch $@

# Collapse byte-identical images into a shared image/ tree and rewrite refs.
# Runs last; the tool preserves HTML mtimes so a second `make htmldocs` is a
# no-op.
.dedup-images-stamp: $(DOC_SRCDIR)/tools/dedup-images.py .htmldoc-stamp
$(Q)python3 $(DOC_SRCDIR)/tools/dedup-images.py --html-root $(DOC_OUT_HTML) --apply
@touch $@

# Inject the whole-document sidebar/topbar and grey out missing language-
# switcher entries. Runs last (depends on every HTML target) and is
# idempotent. Gated on BUILD_DOCS_HTML, not translations: the sidebar comes
Expand Down Expand Up @@ -705,7 +712,7 @@ checkref_en: $(DOC_DIR)/.checkref-english-stamp
# (w3c-linkchecker disables file:// URIs), so the tree may carry accumulated
# broken links. Report them without breaking the build for now; drop this
# flag once the backlog is cleared so regressions fail the build again.
$(DOC_DIR)/.checkref-english-stamp: $(DOC_TARGETS_HTML_EN) $(DOC_OUT_HTML)/en/index.html $(DOC_OUT_HTML)/en/gcode.html .htmldoc-stamp
$(DOC_DIR)/.checkref-english-stamp: $(DOC_TARGETS_HTML_EN) $(DOC_OUT_HTML)/en/index.html $(DOC_OUT_HTML)/en/gcode.html .htmldoc-stamp .dedup-images-stamp
$(DOC_SRCDIR)/checkref --warn-on-failure English $(filter %.html,$^)
@touch $@

Expand Down Expand Up @@ -1313,6 +1320,7 @@ docclean:
-rm -f $(DOC_SRCDIR)/*/*.html
-rm -rf $(DOC_FONT_DIR)
-rm -f .htmldoc-stamp
-rm -f .dedup-images-stamp
-rm -f .copy-asciidoc-stamp
-rm -f .adoc-images-stamp
-rm -f .html-images-stamp
Expand Down
Loading
Loading