docs(build): unified output subtree under docs/build/ #4081
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,54 @@ | ||
| # 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 | ||
|
|
||
| # source-highlight local cache. | ||
| /src/source-highlight/local | ||
|
|
||
|
Comment on lines
+11
to
+13
Contributor
There was a problem hiding this comment. Source-highlight was removed and you are using rouge. All the source-highlight stuff is obsolete. |
||
| # Generated component manpage list (gen_complist.py). | ||
| /src/hal/components_gen.adoc | ||
|
|
||
|
Comment on lines
+14
to
+16
Contributor
There was a problem hiding this comment. Wouldn't it be better to run po4a on the |
||
| # 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 | ||
|
|
||
|
Comment on lines
+18
to
+24
Contributor
There was a problem hiding this comment. These should be generated into the build tree. We should keep the docs/src tree clean from anything generated for as much as possible. |
||
| # Troff manpages generated from .adoc by the asciidoctor manpage backend. | ||
| /man/man1/ | ||
| /man/man3/ | ||
| /man/man9/ | ||
|
Comment on lines
+25
to
+28
Contributor
There was a problem hiding this comment. Aren't they be generated into the right place now? |
||
|
|
||
| # 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/* | ||
|
Comment on lines
+30
to
+54
Contributor
There was a problem hiding this comment. This should now all be under build. |
||
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.
Why have these a leading
/? Using relative paths is a thing ;-)(other places too)