-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Open
Labels
Documentation GenerationRelated to documentation generation (but not content).Related to documentation generation (but not content).
Description
/cc @a-mr
it's too easy to forget about warnings that occur during nim doc generation, because nim's CI (or other repo's CI) typically don't use --warningAsError:listOfRstSpecificWarnings
we should show warnings in generated html to surface those so they're more likely to be fixed (but possibly we can have an option to opt out of this)
Example
for example #17257 introduces a warning, but this warning only shows during compilation, not in generated html output
Current Output
which could've gone completely un-noticed in a real project and would've been bad (for obvious reasons)
Expected Output
we should do like rst2html.py, and show a parsing warning in generated html, so it's obvious that something went wrong and it won't go un-noticed, eg:
echo ':code:`\x`' | rst2html.py > /tmp/z01.html
the html shows:
<stdin>:1: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.
Additional Information
1.5.1 2f213db
Metadata
Metadata
Assignees
Labels
Documentation GenerationRelated to documentation generation (but not content).Related to documentation generation (but not content).
