KApiDox move from dedicated server to Jenkins

[Ben Cooksley]

On Sun, Sep 12, 2021 at 7:07 AM Frederik Schwarzer <schwarzer at kde.org>
wrote:

> Hi,
>

Hi all,


> On 9/10/21 21:17, Ben Cooksley wrote:
> > On Sat, Sep 11, 2021 at 5:40 AM Carl Schwan <carl at carlschwan.eu> wrote:
>
> >> 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
>
> So, we would need to decide whether we want to have applications that
> only have private APIs documented?
>

That is correct.


> Where do we draw the line currently?
>

To date we've not really drawn a line anywhere, but in general I think it
would be best for us to only include API Documentation for projects that
people can actually use externally of the project itself.
(so for Applications, they would need to provide a plugin interface, or a
library that lets people reuse components of it)

Otherwise people might be confused as to what they're looking at.


> In general I would say, just generate everything that has a Doxyfile ...
> but there might be good reasons against that regarding processing power?
>

In the past that has meant that build runs of API Documentation took
several hours.

I'd also recommend taking a look at it from a maintainability point of view
as this is something that will continue to run for some time, so we need to
ensure that if projects do have special requirements that they do not
create issues from that perspective.


> Cheers,
> Frederik
>

Cheers,
Ben
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20210912/e3366b5f/attachment.htm>