Investigate sphinx for user documentation
Open, Needs TriagePublic

Description

Investigate the feasibility of introducing rst/sphinx to generate user documentation in addition to DocBook.

It would require a different code path for PDF and cache generation, or direct support in khelpcenter. If the cache can be generated, maybe no other changes are needed.

That will require a custom sphinx extension:

  • to use custom common "entities" that should be extracted separately
  • (maybe) to generate the cache, if it is possible to create a compatible one

It will also require support for KDocTools for common entities.

ltoscano created this task.Aug 13 2018, 4:04 PM
ognarb added a subscriber: ognarb.Dec 17 2019, 9:45 PM

What is the status of this task?

Stalled right now.

Todos from last Akademy BoF:

  • investigate Sphinx for new documentation (do the KDE-specific stuff
  • add support in kdoctools (wrappers command around sphinx invocation?)
  • investigate how to implement "entity"-like support with a sphinx plugin
  • see how to tune the output format to be used in various places (Plasma Mobile, classic KHelpCenter, docs.kde.org)