docs: support for QtHelp (qch) documentation book format generation #15157
+239
−1
Conversation
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
swagtoy
reviewed
Oct 23, 2025
dnicolodi
reviewed
Oct 23, 2025
MatusGuy
changed the title
Member
eli-schwartz
left a comment
eli-schwartz
left a comment
There was a problem hiding this comment.
Overall this seems pretty unobjectionable and I'm fine accepting it.
Author
|
Sorry for kind of abandoning this, but I forgot to mention that this PR will need the functions document to be split per function. This is because Qt Help viewers struggle a lot when loading the big functions page. This change is already implemented in #15160, so I either cherry pick from that or make this PR dependent on that one. In addition to this, I would also like to try to give this version a nice simplistic theme that follows the system settings. This is necessary to display syntax highlighting. |
|
also you need to fix the html boilerplate you grabbed
…On Sat, Nov 15, 2025, 5:31 AM Marty ***@***.***> wrote:
*MatusGuy* left a comment (mesonbuild/meson#15157)
<#15157 (comment)>
Sorry for kind of abandoning this, but I forgot to mention that this PR
will need the functions document to be split per function. This is because
Qt Help viewers struggle a lot when loading the big functions page. This
change is already implemented in #15160
<#15160>, so I either cherry pick
from that or make this PR dependent on that one.
In addition to this, I would also like to try to give this version a nice
simplistic theme that follows the system settings. This is necessary to
display syntax highlighting.
—
Reply to this email directly, view it on GitHub
<#15157 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AY22OGYWF4EOT4JI3Q35OHD3436GRAVCNFSM6AAAAACJ2WX7ZOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTKMZWGMYDCNZQGU>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This pull request will allow generating the Qt Compressed Help file for use with tools like Qt Creator, Qt Assistant or KDevelop.
The format provides compressed html files with easy reference information. With this information, it's possible to, for example, hit the F1 key in Qt Creator while the cursor is on a Meson function, and read the respective documentation inside of the IDE.