Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
3b6db7e
docs: add asciidoctor extensions and PDF theme
grandixximo May 23, 2026
c13a734
docs: swap HTML, PDF, manpage build rules from asciidoc-py to asciido…
grandixximo May 23, 2026
2a8bcfa
docs: drop the asciidoc-py / dblatex / xsltproc infrastructure
grandixximo May 23, 2026
6ae32b5
debian: switch documentation build-deps to the asciidoctor toolchain
grandixximo May 23, 2026
c5c7551
ci: parallelize the Debian package build via DEB_BUILD_OPTIONS
grandixximo May 23, 2026
a022dc0
docs: fix source issues the asciidoctor parser flags
grandixximo May 23, 2026
5b775f1
docs: resolve inline image macros and fall back to EN tree
grandixximo May 23, 2026
7f511e8
docs: add Rouge lexers for HAL and NGC, wire highlighter into the build
grandixximo May 24, 2026
b0a16fc
build: gate translated docs behind explicit configure flag, fix build…
grandixximo May 24, 2026
5114925
build: fix po4a fail by giving components_gen.adoc its own rule
grandixximo May 24, 2026
1c3e6d3
docs: tighten Rouge HAL and NGC lexers per review
grandixximo May 24, 2026
95f9d0c
docs: render manual-pages PDF via asciidoctor-pdf
grandixximo May 24, 2026
0375f0a
docs: drop legacy asciidoc-py source-lang attribute indirection
grandixximo May 24, 2026
f314b5c
build: fail configure when an explicitly enabled docs dep is missing
grandixximo May 24, 2026
f12a44c
build: probe NotoSerifCJK path portably, drop hardcoded /usr/share
grandixximo May 24, 2026
b765cf3
build: wire CJK_TTFS into manpage PDF rule
grandixximo May 24, 2026
3c30d24
build: revert configure docs-deps to warn-and-disable
grandixximo May 24, 2026
459bc2d
docs: special-case LinuxCNC #<_ini[...]NAME> and #<_hal[...]> in NGC
grandixximo May 24, 2026
2c5075c
docs: auto-substitute foo_en.ext -> foo_<lang>.ext in image resolver
grandixximo May 24, 2026
dbc79d1
docs: address hansu/bertho review, fix CI hangs and HTML styling
grandixximo May 24, 2026
ed929e8
docs: wrap main PDF rule in timeout 900 to bound asciidoctor-pdf hangs
grandixximo May 24, 2026
0ab4f19
ci: skip dh_auto_test on indep build, hangs trixie/bookworm
grandixximo May 24, 2026
385c57e
docs: make manpages prereq of components_gen.adoc order-only
grandixximo May 25, 2026
d1ea806
docs: address bertho 2026-05-25 review
grandixximo May 25, 2026
ad11844
docs: set heading color of PDF to black
hansu May 25, 2026
3100fb3
docs: extend default INI highlighter to include # comments, set synta…
hansu May 25, 2026
7487979
docs: add syntax-highlighting for PDF-docs
hansu May 25, 2026
3dc614c
build: drop nocheck workaround, ignore autom4te.cache
grandixximo May 25, 2026
e1ac2ec
docs: derive HTML language rules from po4a.cfg
grandixximo May 25, 2026
433fe6f
docs(html): theme switcher (legacy/modern) + bullet preprocessor
grandixximo May 25, 2026
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
2 changes: 2 additions & 0 deletions .github/scripts/build-package-arch.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,6 @@ debian/update-dch-from-git
scripts/get-version-from-git | sed -re 's/^v(.*)$/\1/' >| VERSION; cat VERSION
git diff
apt-get --yes build-dep --arch-only .
DEB_BUILD_OPTIONS="parallel=$(nproc)"
export DEB_BUILD_OPTIONS
debuild -us -uc --build=any
2 changes: 2 additions & 0 deletions .github/scripts/build-package-indep.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,6 @@ debian/update-dch-from-git
scripts/get-version-from-git | sed -re 's/^v(.*)$/\1/' >| VERSION; cat VERSION
git diff
apt-get --yes build-dep --indep-only .
DEB_BUILD_OPTIONS="parallel=$(nproc)"
export DEB_BUILD_OPTIONS
debuild -us -uc --build=source,all
4 changes: 4 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ on:
permissions:
contents: read # to fetch code (actions/checkout)

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
DEBIAN_FRONTEND: noninteractive

Expand Down
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,9 @@ position.txt
*.*-stamp
# Ignore VSCode settings
.vscode/settings.json
# autoreconf cache from debian/configure
/autom4te.cache/
# Local dev-only doc server script (do not ship).
/dev-serve-docs.sh
# Playwright MCP scratch dir (browser snapshots / console / etc).
/.playwright-mcp/
14 changes: 1 addition & 13 deletions debian/configure
Original file line number Diff line number Diff line change
Expand Up @@ -110,19 +110,7 @@ elif [ -f /etc/lsb-release ]; then
fi

if [ -n "$ENABLE_BUILD_DOCUMENTATION" ]; then
DOC_DEPENDS="dblatex (>= 0.2.12),\n dvipng,\n fonts-dejavu,\n graphviz,\n groff,\n inkscape,\n librsvg2-bin,\n python3-lxml,\n source-highlight,\n texlive-extra-utils,\n texlive-font-utils,\n texlive-fonts-recommended,\n texlive-lang-cyrillic,\n texlive-lang-european,\n texlive-lang-french,\n texlive-lang-german,\n texlive-lang-polish,\n texlive-lang-spanish,\n texlive-latex-recommended,\n w3c-linkchecker,\n xsltproc"


case $DISTRIB_NAME in
Debian-9)
;; # No xetex in Debian 9 Stretch
*)
# Not quite sure which packages is needed for xetex, but
# texlive-xetex seem like a safe choice. Need xetex to be
# able to build Chinese PDF.
DOC_DEPENDS="$DOC_DEPENDS,\n texlive-xetex"
;;
esac
DOC_DEPENDS="asciidoctor,\n asciidoctor-pdf | ruby-asciidoctor-pdf,\n fonts-dejavu,\n fonts-noto-cjk,\n ghostscript,\n graphviz,\n librsvg2-bin,\n python3-fonttools,\n ruby-rouge,\n w3c-linkchecker"
else
DOC_DEPENDS=''
fi
Expand Down
6 changes: 2 additions & 4 deletions debian/control.top.in
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@ Build-Depends:
@KERNEL_HEADERS@,
@MODUTILS_DEPENDS@,
@EXTRA_BUILD@,
docbook-xsl <!nodoc>,
asciidoc,
ghostscript <!nodoc>,
groff-base <!nodoc>,
imagemagick <!nodoc>,
asciidoc-dblatex <!nodoc>,
asciidoctor <!nodoc>,
libunicode-linebreak-perl <!nodoc>,
autoconf,
automake,
bwidget (>= 1.7),
Expand Down
3 changes: 2 additions & 1 deletion debian/rules.in
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ export TIME:=$(shell LANG=C date --date='@$(TIMESTAMP)' '+%T')
kernel_version = @KERNEL_VERSION@
configure_realtime_arg = @CONFIGURE_REALTIME_ARG@
ifeq (,$(filter nodocs,$(DEB_BUILD_OPTIONS)))
enable_build_documentation = @ENABLE_BUILD_DOCUMENTATION@
enable_build_documentation = @ENABLE_BUILD_DOCUMENTATION@ \
--enable-build-documentation-translation
endif
SRCDIR = $(CURDIR)/src
DESTDIR=$(CURDIR)/debian/tmp
Expand Down
10 changes: 2 additions & 8 deletions docs/help/tklinuxcnc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,6 @@

= TkLinuxCNC

// Custom lang highlight
// must come after the doc title, to work around a bug in asciidoc 8.6.6
:ini: {basebackend@docbook:'':ini}
:hal: {basebackend@docbook:'':hal}
:ngc: {basebackend@docbook:'':ngc}

== Menus

*File -> Run...*::
Expand Down Expand Up @@ -157,7 +151,7 @@ To change these settings, use the '@' key for Commanded/Actual, and
the '#' key for Absolute/Relative. The default values can be set in
the INI file, e.g.,

[source,{ini}]
[source,ini]
----
[DISPLAY]
POSITION_OFFSET = RELATIVE
Expand All @@ -166,7 +160,7 @@ POSITION_FEEDBACK = ACTUAL

or

[source,{ini}]
[source,ini]
----
[DISPLAY]
POSITION_OFFSET = ABSOLUTE
Expand Down
21 changes: 18 additions & 3 deletions docs/html/linuxcnc.css
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
:target { background: #DEF !important; }
:target { background: #DEF !important; }
body { margin: 1em 5% 1em 5%; }
tt {font-family: "Courier New", Courier, monospace; font-size: 0.95em;}
pre { font-family: monospace !important; }
h1, h2, h3, h4, h5, h6 { font-family: Arial, Helvetica, sans-serif; }
h1, h2 { background: #c0c0f0; padding-left: 0.5em;}
h3, h4, h5, h6 { background: #DEF; padding-left: 0.5em; }
h2 { padding-top: 0.35em; padding-bottom:0.15em;}
h1, h2, h3, h4, h5 { border-bottom: 2px solid #8080c0; color: black; }

@media (max-width: 768px) {
body { margin: 0.5em 2% 0.5em 2%; }
}
div.nav { float: right; background: #ffffff; }
dt { font-weight: bold; }
dt { font-weight: bold; color: #527bbd; margin-top: 0.5em; }
pre { margin-left: 4ex; auto; color: black; padding: 1ex; }
div.float { text-align: center; margin: 2ex; padding: 1ex; }
div.float span.caption { display: block; margin: 1em; }
Expand All @@ -28,8 +35,16 @@ table.tableblock { border-collapse: collapse; margin-left: auto; margin-right: a
.clist { -moz-column-width: 40ex; -moz-column-gap: 4ex }
.nclist { -moz-column-width: 20ex; -moz-column-gap: 4ex }
.nclist li { list-style-type: none; text-indent: -.5ex; }
#toctitle {
font-family: Arial, Helvetica, sans-serif;
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1em;
margin-bottom: 0.3em;
}
.toc li { list-style-type: none; }
.toc li a { display: block; border: 1px solid transparent; text-indent: -1ex; }
.toc li a { border: 1px solid transparent; text-indent: -1ex; }

/* AsciiDoc stuff */
div.note {
Expand Down
3 changes: 1 addition & 2 deletions docs/man/images/Images_info.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ Here an example:
----



.toggle2nist: ASCII art generated by asciiwave
----
┐ ┏─────xxxxxxxxxxxx┐ ┏─────xxxxxxxxxxxx┐
Expand Down Expand Up @@ -57,4 +56,4 @@ ASCII art diagrams can be drawn e.g., with link:https://asciiflow.com/[asciiflow
│ │
──┤is-on off├──
└───────────┘
----
----
6 changes: 2 additions & 4 deletions docs/po4a.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
[po4a_paths] po/documentation.pot $lang:po/$lang.po

[po4a_alias:AsciiDoc_def] AsciiDoc opt:"--keep 0 --option 'entry=lang' --option 'tablecells'"
[po4a_alias:man_def] man opt:"--keep 0 -o groff_code=translate -o inline=URL -o untranslated=FF,FU"
[po4a_alias:man_def] man opt:"--keep 0 -o groff_code=translate -o inline=URL,MTO -o untranslated=FF,FU,als -o unknown_macros=untranslated"
[po4a_alias:xhtml_def] xhtml opt:"--keep 0"

# Should stay at 0 percent to make sure the imported python script is
Expand Down Expand Up @@ -128,6 +128,7 @@
[type: AsciiDoc_def] src/hal/general-ref.adoc $lang:src/$lang/hal/general-ref.adoc
[type: AsciiDoc_def] src/hal/hal-examples.adoc $lang:src/$lang/hal/hal-examples.adoc
[type: AsciiDoc_def] src/hal/halmodule.adoc $lang:src/$lang/hal/halmodule.adoc
[type: AsciiDoc_def] src/hal/halscope.adoc $lang:src/$lang/hal/halscope.adoc
[type: AsciiDoc_def] src/hal/halshow.adoc $lang:src/$lang/hal/halshow.adoc
[type: AsciiDoc_def] src/hal/haltcl.adoc $lang:src/$lang/hal/haltcl.adoc
[type: AsciiDoc_def] src/hal/halui-examples.adoc $lang:src/$lang/hal/halui-examples.adoc
Expand Down Expand Up @@ -360,9 +361,6 @@
[type: AsciiDoc_def] src/plasma/plasma-cnc-primer.adoc $lang:src/$lang/plasma/plasma-cnc-primer.adoc
[type: AsciiDoc_def] src/plasma/qtplasmac.adoc $lang:src/$lang/plasma/qtplasmac.adoc
[type: AsciiDoc_def] src/remap/remap.adoc $lang:src/$lang/remap/remap.adoc
[type: AsciiDoc_def] src/source-highlight/hal-demo.adoc $lang:src/$lang/source-highlight/hal-demo.adoc
[type: AsciiDoc_def] src/source-highlight/ini-demo.adoc $lang:src/$lang/source-highlight/ini-demo.adoc
[type: AsciiDoc_def] src/source-highlight/ngc-demo.adoc $lang:src/$lang/source-highlight/ngc-demo.adoc
[type: AsciiDoc_def] src/tooldatabase/tooldatabase.adoc $lang:src/$lang/tooldatabase/tooldatabase.adoc
[type: AsciiDoc_def] src/user/starting-linuxcnc.adoc $lang:src/$lang/user/starting-linuxcnc.adoc
[type: AsciiDoc_def] src/user/user-concepts.adoc $lang:src/$lang/user/user-concepts.adoc
Expand Down
2 changes: 2 additions & 0 deletions docs/src/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
*.xml
!docs.xml
!terms.xml
.fonts/
drivers/mb2hal_HOWTO.ini
*/drivers/mb2hal_HOWTO.ini
# Ignore po4a-generated files for other languages
Expand Down Expand Up @@ -31,3 +32,4 @@ vi/*
zh_CN/*
index_*.tmpl
man/man1/linuxcnc.1.adoc
rouge-*.css
7 changes: 7 additions & 0 deletions docs/src/Master_Documentation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
:leveloffset: 0
= Getting Started & Configuration


:leveloffset: 1
= Getting Started with LinuxCNC

Expand Down Expand Up @@ -78,6 +79,7 @@ include::config/stepper-diagnostics.adoc[]

include::gui/filter-programs.adoc[]


:leveloffset: 1
= HAL (Hardware Abstraction Layer)

Expand Down Expand Up @@ -205,6 +207,7 @@ include::tooldatabase/tooldatabase.adoc[]
:leveloffset: 0
= Usage


:leveloffset: 1
= User Interfaces

Expand Down Expand Up @@ -302,19 +305,23 @@ include::gui/vismach.adoc[]
:leveloffset: 0
= Glossary, Copyright & History


:leveloffset: 1
= Overleaf
include::common/overleaf.adoc[]


:leveloffset: 1
include::common/glossary.adoc[]


:leveloffset: 1
= Copyright

:leveloffset: 2
include::common/gpld-copyright.adoc[]


:leveloffset: 1
= LinuxCNC History

Expand Down
Loading
Loading