Hi,
Steve was so kind to add kf6-kapidox (the one where noone knows what it is good for) and Jan was so kind to add qt6-doc that I now have split up into useful parts. Thank you, guys ;-) :love_letter:
QtCreator, KDevelop and Qt Assistant use QCH (Qt Compressed Help format) files for their API documentation display and an according .tags file for the qch file generated that is used for cross-linking other qch files to it.
So, to generate "right" qch files for all of kf6 (and other stuff), the rpms need:
BuildRequires: kf6-kapidox
and an according -doc package:
%package doc Summary: Developer Documentation files for %{name} %description doc Developer Documentation files for %{name} for use with KDevelop or QtCreator.
plus a cmake option:
%cmake_kf6 \ -DBUILD_QCH:BOOL=ON
and then the build uses doxygen and qt6-doc-devel (as a Requires from kf6-kapidox) automatically to crosslink to Qt Qch files.
The results have to be added like this:
%files devel ....(append at end:) %{_qt6_docdir}/*.tags
%files doc %{_qt6_docdir}/*.qch
The tags files from the kf6 packages have to go to the -devel package, because then the kf6 packages requiring the prior kf6 packages (and their tags files) as dependencies for a build automatically pick up all dependencies without any further change, too.
The result is a complete set of Qt6 and KF6 API documentation in QCH file format for the IDEs availabe and 1:1 identical with the software installable (version-identical).
The issue I'm still working on is how to use the doxygen template in kf6-kapidox so the output looks more kde-ish like on the webpage.
One issue I found:
kf6-kio already has a -doc package (for the kde help system to display the KIOs installed for the user help how to use it), so my proposal for kf6-kio would be for the qch file to name it qch-doc (as noone really wanted to have all rpms with only the qch file named -qch ;-)
So proposals welcome before I'v e got to change that 3 times over ;-)
Metadata Update from @farchord: - Issue set to the milestone: Fedora Linux 40 - Issue tagged with: meeting, packaging, pending-action
I think using a different subpackage suffix than "-doc" would be better here... maybe something like "-qch"?
I added the cmake switch and kf6-kapidox to the kf6 macros, so only little changes will be needed in each package, just add the doc package and add the non-packaged files at the end of the build for each:
https://src.fedoraproject.org/rpms/kf6/pull-request/4
Example here: https://src.fedoraproject.org/rpms/kf6-kcodecs/pull-request/1
Build log here: https://download.copr.fedorainfracloud.org/results/loise/kf6-API/fedora-rawhide-x86_64/06864882-kf6-kcodecs/builder-live.log.gz
Changes required to spec file:
I'm leaving this question to the majority, whatever seems best. I'd go with qch, too, but that's just me. Ubuntu uses -doc for this purpose shipping the qch files in their kf5 libs
This is now implemented in kf6 and now all the kf6- packages need updating.
kf6-
Packages NOT requiring any change as they don't have and QCH generation enabled/available:
kf6-kded kf6-frameworkintegration kf6-qqc2-desktop-style kf6-kimageformats kf6-purpose kf6-kuserfeedback breeze-icon-theme kf6-kquickcharts
Otherwise, kf6 is complete and changes merged
Metadata Update from @aleasto: - Issue close_status updated to: Fixed - Issue status updated to: Closed (was: Open)
Issue status updated to: Open (was: Closed)
Issue status updated to: Closed (was: Open) Issue close_status updated to: Fixed
Log in to comment on this ticket.