On Thu, Jan 15, 2026 at 9:54 AM Albert Astals Cid <[email protected]> wrote:
> El dimecres, 14 de gener del 2026, a les 12:34:59 (Hora estàndard d’Europa > central), Luigi Toscano va escriure: > > Benson Muite ha scritto: > > > On Wed, Jan 14, 2026, at 1:42 PM, Johnny Jazeix wrote: > > >> Hi, > > >> > > >> Since we restored docs.kde.org, I would like to propose to add a new > > >> item in the checklist [1] for new projects (rewording welcome if > > >> needed): > > >> - [ ] User documentation in docbook format should exist in a doc (or > > >> docs) folder > > > > > > Docbook is nice and can be converted to html for web or viewed > > > directly using desktop applications. Would authoring in other formats > > > and converting to Docbook also be allowed? For example Sphinx > > > uses ReStructured Text which can be converted to DocBook, TexInfo > > > can also be converted to DocBook. > > > > Right now, the source format used by khelpcenter and docs.kde.org is > > docbook. A few bigger manual uses sphinx, (digikam, kdenlive, krita, > > kstars) but that require a specialized site and I would consider that an > > exception and not the rule for now. > > We also generate man pages from docbook, I would definitely rule out > > TexInfo. If/when we manage to pull enough work to support sphinx in > > kdoctools we can consider sphinix as regular, but not right now. > > Any new format for end user documentation needs to also consider how we do > translations. We have that solved for docbook. > Sphinx does have that solved, to a certain extent at least. It isn't terribly efficient though so more work is required there - likely a rewrite of how it does things. > > Cheers, > Albert > > > > Cheers, Ben
