Details
Diff Detail
- Repository
- R240 Extra CMake Modules
- Lint
Automatic diff as part of commit; lint not applicable. - Unit
Automatic diff as part of commit; unit tests not applicable.
related to D6603
@ochurlaud I hope this will not break api.kde, given ECM hasn't had a metainfo.yaml previously it seems to have some sort of special arrangement?
No it has no reason to break.
Did you try it locally on ECM only (or better : ECM + kapidox) ?
Good point on trying it locally.
So, as one could expect this adds ECM as a product
Unfortunately given we have no actual documentation (outside the cmake documentation) this leads to a fairly useless page
Am I right in assuming that the way to fix this is to write a mainpage which links to https://api.kde.org/ecm/ for the actual cmake documentation?
At the time I thought about merging it but we would have to re-document everything in doxygen , which would be completely different from what upstream cmake does.
The ECM page is already linked from the left menu. Does it make sense to have it in frameworks? It's more a prerequisite for the framework no?
Anyway, a link would work though being suboptimal.
The metainfo.yaml is a prerequisite for frameworks I think, yeah. If we could add a property to the yaml generateApiDox: false to prevent doxification of ECM that would also work all be it more work I suppose.
BUT
In a way, I am thinking that for consistency's sake it is actually nicer if ECM is listed alongside the other frameworks on https://api.kde.org/frameworks/index.html even if it then only links to the cmake documentation. It is, at the very least, more discoverable this way.
add a readme
I've tried for like 2 hours to wire this into the existing docs
build and get away with one README. Alas, no luck.