-
Notifications
You must be signed in to change notification settings - Fork 1.3k
docs(build): unified output subtree under docs/build/ #4081
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.
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
16
commits into
LinuxCNC:master
Choose a base branch
from
grandixximo:docs/unified-build-output
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
932cf1b
docs(build): unified output subtree under docs/build/
grandixximo c29adc8
docs(build): pass fixturedir to PDF rule, copy en/gcode.html uncondit…
grandixximo da91abf
docs(build): substitute fixturedir attribute in asciideps dependency …
grandixximo 0e7ff74
docs(build): move PDFs from html/<lang>/pdf/ to pdf/<lang>/
grandixximo 68be4f6
docs(build): gen_complist checks manpage source set, not rendered HTML
grandixximo a00746b
docs: move docs/help/ under docs/src/help/
grandixximo 01a5a6b
docs(build): make pdfdocs idempotent on no-op rebuilds
grandixximo 14a7e37
docs(build): fix asciideps gluing $DIR onto absolute include paths
grandixximo e21878d
docs(build): drop build-time mandb whatis step
grandixximo 4caa75c
docs(build): emit English master PDFs into objects/ not docs/src
grandixximo a63075b
docs: consolidate gitignores into docs/.gitignore
grandixximo 4e3a947
docs(build): move PDFs under html tree, suffix every PDF with _<lang>
grandixximo 38572cb
docs(build): mark make-docs-pdf-index executable
grandixximo 569b2b7
docs: revert pot/po to master (keep weblate as source of truth)
grandixximo d08fdfc
docs: inline mb2hal_HOWTO.ini into docs tree, drop {fixturedir} hack
grandixximo e4b2922
docs: gitignore relative paths, drop obsolete source-highlight
grandixximo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,51 @@ | ||
| # generated when building pdf docs | ||
| index.html | ||
| # All ignores for the documentation tree live here (not in the top-level | ||
| # .gitignore). Paths are relative to docs/. | ||
|
|
||
| # Rendered output: HTML, PDF, and po4a-translated .adoc all land under build/. | ||
| build/ | ||
|
|
||
| # Intermediate .html asciidoctor writes beside each source .adoc before the | ||
| # copy step moves it into build/html/. | ||
| src/*/*.html | ||
|
|
||
| # Generated component manpage list (gen_complist.py). | ||
| src/hal/components_gen.adoc | ||
|
|
||
| # SVGs rendered from the .dot sources in src/code/ (CMS_buffer.svg is committed). | ||
| src/code/homing.svg | ||
| src/code/homing_es.svg | ||
| src/code/hss.svg | ||
| src/code/hss_es.svg | ||
| src/code/task-state-transitions.svg | ||
| src/code/task-state-transitions_es.svg | ||
|
|
||
| # Troff manpages generated from .adoc by the asciidoctor manpage backend. | ||
| man/man1/ | ||
| man/man3/ | ||
| man/man9/ | ||
|
|
||
| # po4a-translated man trees. | ||
| man/ar/* | ||
| man/bg/* | ||
| man/ckb/* | ||
| man/cs/* | ||
| man/da/* | ||
| man/de/* | ||
| man/es/* | ||
| man/fr/* | ||
| man/hu/* | ||
| man/it/* | ||
| man/ka/* | ||
| man/nb/* | ||
| man/pl/* | ||
| man/pt/* | ||
| man/pt_BR/* | ||
| man/ro/* | ||
| man/ru/* | ||
| man/sai/* | ||
| man/sk/* | ||
| man/sv/* | ||
| man/tr/* | ||
| man/uk/* | ||
| man/vi/* | ||
| man/zh_CN/* | ||
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't it be better to run po4a on the
build/adoc/entree and not have to generate thecomponents_get.adocin the src tree?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed it's cleaner. The catch:
components.adocincludescomponents_gen.adocwith a plain relative include, so they must sit in the same dir. To generate it intobuild/adoc/en/hal/, English has to render frombuild/adoc/en/like the translations do, otherwise the src-treecomponents.adoccan't resolve the include without a{fixturedir}-style hack.That's a deeper change (the
enpipeline is special-cased throughout the Submakefile), so I'd do it as its own follow-up. Two ways to populatebuild/adoc/en/:ento po4a as an identity passthrough (emptyen.po,--keep 0). Reuses po4a's tree generation, but touchespo/..adoc+ images intobuild/adoc/en/and point the render rules there. Nopo/touch.Which do you prefer? The same move then lets the
.dotSVGs generate intobuild/too.Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
grandixximo/linuxcnc@docs/unified-build-output...docs/render-en-from-build
Went for no
po/touchingExpand scope here? Wait for follow up PR?