Documentation revamp update
Nicolas Fella
nicolas.fella at gmx.de
Fri May 16 15:11:44 BST 2025
Hi,
I'm not entirely sure yet, but I suspect this happens because both
KF6::I18n and KF6::I18nQml define things in the KLocalization namespace
but only the content from KF6::I18nQml is visible.
Am 06.05.25 um 11:54 schrieb Lukas Sommer:
> It seems that functions in namespaces are not always documented.
> Example: https://api-staging.kde.org/klocalization.html does not
> contain documentation for KLocalization::setupSpinBoxFormatString()
> while
> https://api.kde.org/frameworks/ki18n/html/namespaceKLocalization.html
> does.
>
> Lukas Sommer
>
>
> Am Fr., 4. Apr. 2025 um 12:48 Uhr schrieb Nicolas Fella
> <nicolas.fella at gmx.de>:
>
> Hi,
>
> I'm happy to announce a major milestone in our effort to improve
> our API
> documentation website by porting it to QDoc.
>
> We now have a preview of the new site available at
> https://api-staging.kde.org/, with all Frameworks converted to the new
> syntax.
>
> Please have a look and report any issues. We do have some flexibility
> regarding content and appearance, but please understand that we
> have to
> work within what QDoc provides, so we might not be able to accommodate
> all requests easily.
>
> One major thing that's currently missing is a search function. There's
> some thoughts and a WIP at
> https://invent.kde.org/teams/documentation/sprints/-/issues/81. Help
> with this and other web-development topics is welcome.
>
> Currently the documentation syntax changes for the frameworks are in a
> separate branch, we will merge these to master as we are going
> live with
> the new site.
>
> The current plan is to go live with Frameworks only once the site is
> ready, other libraries can be converted/added over time.
>
> You can find some instructions about converting in
> https://invent.kde.org/-/snippets/3206
>
> Thanks to everyone who contributed to this effort!
>
> Cheers
>
> Nico
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-devel/attachments/20250516/4382f08c/attachment.htm>
More information about the kde-devel
mailing list