Many projects use Sphinx as a documentation generator. If the documentation has images, man pages are typically not suitable and either documentation is not packaged, or a separate package containing an entire set of html, css and javascript for search is packaged.
It is possible to use Sphinx to produce texinfo output[0], and from texinfo output, use makeinfo to generate a docbook xml file with an associated directory of images[1]. This can be viewed in at least Yelp[2] and Khelpcenter[3] which have their own search engines and give a consistent user experience. Installation needs to follow Freedesktop guidelines[4]. An example build is at [5], though install location and possibly additional metadata/install macros might be needed to make it easy to use such a system. Would this be a way of packaging documentation upstream projects use Sphinx? Would it be worth extending to other website documentation generators such as RubyDoc? Benson 0) https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.texinfo.TexinfoBuilder 1) https://ftp.gnu.org/old-gnu/Manuals/texinfo-4.2/html_node/makeinfo-options.html 1) https://packages.fedoraproject.org/pkgs/yelp/yelp/ 2) https://packages.fedoraproject.org/pkgs/khelpcenter/khelpcenter/ 3) https://www.freedesktop.org/wiki/Specifications/help-spec/ 4) https://koji.fedoraproject.org/koji/taskinfo?taskID=131831660 -- _______________________________________________ devel mailing list -- devel@lists.fedoraproject.org To unsubscribe send an email to devel-le...@lists.fedoraproject.org Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/ List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org Do not reply to spam, report it: https://pagure.io/fedora-infrastructure/new_issue
