KApiDox move from dedicated server to Jenkins

[Ben Cooksley]

On Sat, Sep 11, 2021 at 5:40 AM Carl Schwan <carl at carlschwan.eu> wrote:

> Le vendredi 10 septembre 2021 à 7:23 PM, Frederik Schwarzer <
> schwarzer at kde.org> a écrit :
>
> > Hi,
>
> Hi :D
>

Hey Carl,


> > we have been working on getting KApiDox to run on Jenkins. This work has
> > been taken way longer than I expected but has now reached a state close
> > to finished. :)
> >
> > So I would like to invite you to check https://api-dev.kde.org/ for any
> > show stoppers.
>
> Great work :D
>
> I see on an issue that I would qualify as blocking and it's the lack of the
> ECM generated doc: https://api-dev.kde.org/ecm. We are also losing the
> kube/sink doc (located at api.kde.org/doc/sink) but it's also available
> in readthedocs and ihmo it should be in Doxygen format.
>

My understanding is that ECM uses something other than Doxygen for
generating it's API Documentation, which is why it is absent.

Would anyone on the list know if it is possible to get this process to use
Doxygen, or if we need to put in place a mechanism explicitly for ECM?


> We also are losing the krita/kmymoney/other app private api generation,
> but that maybe can be generated in another ci pipeline later. Not sure how
> much thses apps' developers are using it.
>

This can likely be rectified if needed by including them within
https://invent.kde.org/sysadmin/binary-factory-tooling/-/blob/master/apidocs/repos-to-process


> On the upside, I see that mauikit doc is finally correctly generated using
> qdoc. Yeah \o/
>

Yes, the new setup allows us to provide this now - and being Docker image
based for the generation phase should make future updates easier as well as
needed.


> Cheers,
> Carl
>

Thanks,
Ben

>
> > Known issues (not show stoppers):
> >
> > -   For now the Maintainers field defaults to "KDE Developers" for
> >     potential GDPR violation reasons, which needs to be figured out
> later.
> > -   Some modules contain formatting issues regarding markdown code
> blocks.
> >     These are also there in the current system and need to be checked at
> >     some point.
> > -   The "Older versions" links are broken. Since those docs are not
> >     generated anymore, we need to figure out a way to have them available
> >     statically.
> >
> >     If we do not see any bigger issues, I would like to go live with the
> new
> >     system in a week or two.
> >
> >     Thanks for your help.
> >
> >     CHeers,
> >     Frederik
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20210911/b3d8ab6c/attachment-0001.htm>