Menu
▾
▴
[Emc-commit] [LinuxCNC/linuxcnc] 7a8371: docs(html): KiCAD-inspired topbar, side TOC, langu...
|
From: BsAtHome <no...@gi...> - 2026-06-07 13:05:38
|
Branch: refs/heads/master Home: https://github.com/LinuxCNC/linuxcnc Commit: 7a8371e80733805dfc0c3d2637579eb1e568207b https://github.com/LinuxCNC/linuxcnc/commit/7a8371e80733805dfc0c3d2637579eb1e568207b Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M docs/README.adoc M docs/po4a.cfg A docs/src/.gitignore M docs/src/Submakefile M docs/src/code/building-linuxcnc.adoc M docs/src/code/contributing-to-linuxcnc.adoc A docs/src/docinfo-header.html.in R docs/src/gcode.html A docs/src/gcode.html.in M docs/src/index.tmpl A docs/src/lang_switcher_postprocess.py A docs/src/lcnc-docs.svg M docs/src/lcnc-overrides.css Log Message: ----------- docs(html): KiCAD-inspired topbar, side TOC, language switcher, admonition tints Re-implemented on top of PR #4081's docs/build/ layout. Replaces the previous prototype branch (commit 766f2d9103) which targeted the pre-#4081 docs/html/ paths. - Sticky topbar with LinuxCNC logo on every page; matches asciidoctor's footer colour scheme. Logo SVG lives at docs/src/lcnc-docs.svg and is copied into docs/build/html/ by the shared-asset rule. - Side TOC via asciidoctor :toc=left; auto-hides below 800px (CSS). - Language switcher in the topbar (top-right) built from po4a.cfg + a LANG_LABEL_<lang> map in Submakefile, so po4a.cfg stays the single source of truth. - Admonition blocks (note/tip/warning/caution/important) tinted by type with Unicode icons mapped onto asciidoctor's icons=font output (no FontAwesome dep). Build-time injection: - docs/src/docinfo-header.html generated from .html.in template; asciidoctor pages pick it up via docinfo=shared. - docs/src/gcode.html renamed to gcode.html.in (po4a master); per-lang docs/build/html/<lang>/gcode.html generated from po4a's gcode-raw.html + per-lang topbar fragment. - Per-lang docs/build/html/<lang>/index.html similarly gets topbar injection + CSS path rewrite + objects/index.incl appended so the manpage list is present on translated indexes too. - docs/src/index.tmpl's hardcoded Translations: list dropped; topbar switcher replaces it. - English + translated manpage HTML rules pass lcnc-lang-label and lcnc-subpath so the switcher works on manpages. Per-page language indication via lang_switcher_postprocess.py: walks docs/build/html at end of build, looks up each page's master in each lang's .po, counts msgid-with-master-loc vs translated, toggles class=lcnc-lang-unavail on the <li> when coverage falls below POKEEP (default 80). Same pass marks details-list entries (manpage index lists) whose target file does not exist for the current language. Idempotent: same toggle pattern across re-runs. POKEEP is overridable on the make command line (POKEEP=30 surfaces in-progress translations); contributing-to-linuxcnc.adoc, building-linuxcnc.adoc, and docs/README.adoc document the knob. CSS adds .lcnc-lang-unavail and .lcnc-link-unavail rules: dim text, pointer-events: none, cursor not-allowed; .lcnc-link-unavail also adds strikethrough for the index list context. Commit: 844514f632af11822f984cb02ace791509cd1bce https://github.com/LinuxCNC/linuxcnc/commit/844514f632af11822f984cb02ace791509cd1bce Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M docs/src/Submakefile A docs/src/lang-labels Log Message: ----------- docs: read switcher labels from lang-labels file, not Submakefile Move the native language display names out of the makefile into docs/src/lang-labels (tag<ws>name). A language in po4a.cfg without an entry falls back to its tag with a make warning. Commit: 0c5ad89d29c8f5a1ebb57278e3c39ca6849be88a https://github.com/LinuxCNC/linuxcnc/commit/0c5ad89d29c8f5a1ebb57278e3c39ca6849be88a Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M docs/src/lang_switcher_postprocess.py M docs/src/lcnc-overrides.css Log Message: ----------- docs: per-page translation banner instead of greying switcher Drop the POKEEP percent-threshold hiding: every present translation stays clickable; the switcher only greys a target that does not exist. A page below 100% now carries a no-JS banner below the topbar stating its completeness, tinted red(0%) to green(100%). Commit: 43bc9aa4448443ea2a149393a3807be328db1bb2 https://github.com/LinuxCNC/linuxcnc/commit/43bc9aa4448443ea2a149393a3807be328db1bb2 Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M docs/src/lang_switcher_postprocess.py M docs/src/lcnc-overrides.css Log Message: ----------- docs: whole-document TOC tree in left sidebar Build a nested nav tree from the Master_*.adoc structure and inject it at the top of asciidoctor's left TOC (no JS, native <details>). Each page gets the tree with its branch expanded, its entry active, and its own section list nested under it. Section-less pages get a scaffolded sidebar. CSS-drawn markers override asciidoctor's absolute summary marker so they stay in flow. Commit: 6809642a1813c04433e0b50c02d8eec7b142a32a https://github.com/LinuxCNC/linuxcnc/commit/6809642a1813c04433e0b50c02d8eec7b142a32a Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M docs/po4a.cfg M docs/src/docinfo-header.html.in M docs/src/index.tmpl M docs/src/lang_switcher_postprocess.py M docs/src/lcnc-overrides.css A docs/src/topbar-labels Log Message: ----------- docs: move site links into the topbar Add the LinuxCNC site links (Home, Wiki, Forum, Source, G-Code reference) centred in the topbar so they are reachable from every page, and drop the duplicate block from the landing page. Commit: b2db6c4c1fa4d681e742eb1bc3ac55271e5b9263 https://github.com/LinuxCNC/linuxcnc/commit/b2db6c4c1fa4d681e742eb1bc3ac55271e5b9263 Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M docs/src/Submakefile Log Message: ----------- docs: keep the HTML doc build idempotent The lang-switcher post-processor rewrites every generated HTML page in place as the final step, which bumped their mtimes past three stamps that had consumed the same files earlier in the build. A second make then re-fired the image copy, the shared-asset copy and the complist stamp (and the .htmldoc-stamp / checkref that depend on it), so the build never settled. - .html-images-stamp now depends on .lang-switcher-stamp, so it reads the final post-processed HTML and stays newer than it. - .copy-asciidoc-stamp's gcode.html dependency and .gen_complist-stamp's MAN_HTML_TARGETS dependency become order-only: both only need the files built, not their (later-rewritten) content. A second and third make are now true no-ops. Commit: 602dc0a2cb52e25203ae0798111e80ee8df6fae1 https://github.com/LinuxCNC/linuxcnc/commit/602dc0a2cb52e25203ae0798111e80ee8df6fae1 Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M docs/src/lang_switcher_postprocess.py Log Message: ----------- docs: point the topbar logo at the current language's home The logo linked to the generic index.html, which always redirects to English; on a translated page that silently dropped the language. The post-processor now retargets it to <lang>/index.html. Commit: 00ad58c370f394694f22a3f046744df363b1af07 https://github.com/LinuxCNC/linuxcnc/commit/00ad58c370f394694f22a3f046744df363b1af07 Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M docs/src/lang_switcher_postprocess.py M docs/src/lcnc-overrides.css Log Message: ----------- docs: fold the nav tree down to the active page Expand only the branch leading to the current page instead of the whole book, and put the page's own section list in a collapsed "On this page" details, so sibling pages in the section stay visible. Commit: 6f2dafb021bc28d675ed3b2eee9592e49e98fded https://github.com/LinuxCNC/linuxcnc/commit/6f2dafb021bc28d675ed3b2eee9592e49e98fded Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M docs/src/lang_switcher_postprocess.py M docs/src/lcnc-overrides.css Log Message: ----------- docs: active TOC page toggles its own sections inline The active page is now the disclosure itself: its name is the summary that folds its section list, instead of a separate "On this page" block. Match summary size to the sibling links. Commit: 16b7dfa3d74e928c519cf07a4b24624262eca99e https://github.com/LinuxCNC/linuxcnc/commit/16b7dfa3d74e928c519cf07a4b24624262eca99e Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M debian/copyright M docs/src/Submakefile A docs/src/admon-caution.svg A docs/src/admon-important.svg A docs/src/admon-note.svg A docs/src/admon-tip.svg A docs/src/admon-warning.svg M docs/src/lcnc-overrides.css Log Message: ----------- docs: SVG admonition icons tinted per type Replace the unicode-glyph admonition icons (font-dependent, often not rendered) with Bootstrap Icons drawn as a CSS mask, painted with each block's own colour so they tint per type in both themes. The word label is kept off-screen as the accessible text. Adds the five SVGs to the shared HTML assets and an Expat copyright stanza. Commit: f4889b592afbb042f2e375d82ae63d25f360d828 https://github.com/LinuxCNC/linuxcnc/commit/f4889b592afbb042f2e375d82ae63d25f360d828 Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M docs/src/Submakefile M docs/src/lang_switcher_postprocess.py Log Message: ----------- docs: inject sidebar on English-only builds too The whole-document sidebar and topbar were only injected when BUILD_DOCS_TRANSLATED=yes, so an English-only build produced pages with no navigation at all. The sidebar is derived from the Master_*.adoc structure and is language-independent, so gate the post-processor on BUILD_DOCS_HTML instead; with no languages the switcher and banner just go idle. The post-processor now also accepts an empty language list. Commit: db32422e122d4bc383f695876f0e11525095738a https://github.com/LinuxCNC/linuxcnc/commit/db32422e122d4bc383f695876f0e11525095738a Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M docs/src/lcnc-overrides.css Log Message: ----------- docs: white-back PNG figures in dark mode too Transparent black-line PNG diagrams vanished on the dark page; only SVGs got a white backing. Back every figure with white (opaque screenshots cover it, so no frame); keep the padded white card for SVGs. Commit: 5924d63c2ac3d65b19a0f4a009c27fb4832d8ad0 https://github.com/LinuxCNC/linuxcnc/commit/5924d63c2ac3d65b19a0f4a009c27fb4832d8ad0 Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M docs/src/lcnc-overrides.css Log Message: ----------- docs: restore page and sidebar scrollbars via scrollbar-color Commit: cf8ec666c22aaed8ab621c2652225069e74c5320 https://github.com/LinuxCNC/linuxcnc/commit/cf8ec666c22aaed8ab621c2652225069e74c5320 Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M docs/src/lang_switcher_postprocess.py Log Message: ----------- docs: strip asciidoctor index terms from sidebar titles Commit: 0b937cb5f72c4cac5a4f4b703a2096f7dc8c7fa5 https://github.com/LinuxCNC/linuxcnc/commit/0b937cb5f72c4cac5a4f4b703a2096f7dc8c7fa5 Author: Luca Toniolo <107...@us...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M docs/src/lcnc-overrides.css Log Message: ----------- docs: inset admonition icon mask so its top is not clipped Commit: cfa3a17b4185f784718aee1fa8ba8bf23f8f11a9 https://github.com/LinuxCNC/linuxcnc/commit/cfa3a17b4185f784718aee1fa8ba8bf23f8f11a9 Author: BsAtHome <be...@va...> Date: 2026-06-07 (Sun, 07 Jun 2026) Changed paths: M debian/copyright M docs/README.adoc M docs/po4a.cfg A docs/src/.gitignore M docs/src/Submakefile A docs/src/admon-caution.svg A docs/src/admon-important.svg A docs/src/admon-note.svg A docs/src/admon-tip.svg A docs/src/admon-warning.svg M docs/src/code/building-linuxcnc.adoc M docs/src/code/contributing-to-linuxcnc.adoc A docs/src/docinfo-header.html.in R docs/src/gcode.html A docs/src/gcode.html.in M docs/src/index.tmpl A docs/src/lang-labels A docs/src/lang_switcher_postprocess.py A docs/src/lcnc-docs.svg M docs/src/lcnc-overrides.css A docs/src/topbar-labels Log Message: ----------- Merge pull request #4113 from grandixximo/docs/topbar-greyout-on-build docs(html): KiCAD-inspired topbar, side TOC, language switcher, admonition tints Compare: https://github.com/LinuxCNC/linuxcnc/compare/5f10ab741d13...cfa3a17b4185 To unsubscribe from these emails, change your notification settings at https://github.com/LinuxCNC/linuxcnc/settings/notifications |
