1367738 - Fix build warnings in new POD build and elsewhere

Status: NEW

(Bugzilla :: Documentation, enhancement)

Description

[Gervase Markham [:gerv]]

Bug 1314854 means we now build the POD into the RST, but it fires a bunch of warnings to do with parsing our POD. We should fix those.

Gerv

Comment 1

[Gervase Markham [:gerv]]

It seems like these warnings are symptomatic of the fact that we have several different ways of formatting our POD, particularly in the documentation of methods, and those convert to RST quite differently. Before we "fix" the warnings, we should probably decide what the best way of documenting methods is, so we can convert all sections to use it.

For example, Bugzilla/Auth.pm (once converted to RST) throws indentation errors, but that's because it's treating the method definitions like a definition list, which may not be the right thing.

Gerv