cmake: Avoid rst2html warnings in on-the-fly generated html documentation
ClosedPublic

Authored by kossebau on Oct 3 2018, 12:09 PM.

Details

Summary

rst2html reports warnings about the rst syntax into the generated html,
unless told to switch to another report level, like with --quiet.
As the user cannot (or does not want to) do anything about the cmake docs
when just using them, hide any warnings from them.

Test Plan

CMake docs are still shown, now without any rst syntax warnings (e.g. for
CMake's "project".

Diff Detail

Repository
R32 KDevelop
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
kossebau created this revision.Oct 3 2018, 12:09 PM
Restricted Application added a project: KDevelop. · View Herald TranscriptOct 3 2018, 12:09 PM
Restricted Application added a subscriber: kdevelop-devel. · View Herald Transcript
kossebau requested review of this revision.Oct 3 2018, 12:09 PM

Forgot to mention: the parameter "--quiet" seems to be around since at least 2005, see date stamp on the docs of docutils 0.4: http://docutils.sourceforge.net/0.4/docs/user/config.html
So should be safe to use unconditionally.

kfunk accepted this revision.Oct 3 2018, 12:52 PM
This revision is now accepted and ready to land.Oct 3 2018, 12:52 PM
This revision was automatically updated to reflect the committed changes.