summaryrefslogtreecommitdiff
path: root/hadrian/src
diff options
context:
space:
mode:
Diffstat (limited to 'hadrian/src')
-rw-r--r--hadrian/src/Rules/Documentation.hs15
1 files changed, 15 insertions, 0 deletions
diff --git a/hadrian/src/Rules/Documentation.hs b/hadrian/src/Rules/Documentation.hs
index f39d52c512..6898fd12e5 100644
--- a/hadrian/src/Rules/Documentation.hs
+++ b/hadrian/src/Rules/Documentation.hs
@@ -127,6 +127,21 @@ checkSphinxWarnings :: FilePath -- ^ output directory
-> Action ()
checkSphinxWarnings out = do
log <- liftIO $ readFile (out -/- ".log")
+ when ("Inline literal start-string without end-string." `isInfixOf` log)
+ $ fail $ unlines
+ [ "Syntax error found in Sphinx log. "
+ , ""
+ , "This likely means that you have forgotten a \\ after inline code block. For instance,"
+ , "you might have written:"
+ , ""
+ , " are not allowed to contain nested ``forall``s."
+ , ""
+ , "Whereas you need to write:"
+ , ""
+ , " are not allowed to contain nested ``forall``\\s."
+ , ""
+ ]
+
when ("reference target not found" `isInfixOf` log)
$ fail "Undefined reference targets found in Sphinx log."