Open Bug 1798164 Opened 3 years ago

Compile POD docs in RST format for Sphinx

Categories

(Bugzilla :: Documentation, enhancement)

enhancement

Tracking

()

UNCONFIRMED

People

(Reporter: hellcp, Unassigned)

Details

Currently docs built by docs/makedocs.pl are processed into HTML or PDF directly by the script. However that is not something Sphinx itself recognizes, so those docs are not searchable from Sphinx, and look radically different from the rest of the documentation.

There's no direct way to compile POD into RST, but it is possible to use Pod::Simple::Pandoc to convert it through Pandoc, and only then run Sphinx with the complete set of docs. This way we can have fully searchable, consistent and complete Bugzilla documentation accessible on ReadTheDocs.

You need to log in before you can comment on or make changes to this bug.