diff --git a/docs/docsite/rst/installation_guide/_config.rst b/docs/docsite/rst/installation_guide/_config.rst deleted file mode 100644 index 6f04244e7d7..00000000000 --- a/docs/docsite/rst/installation_guide/_config.rst +++ /dev/null @@ -1,3 +0,0 @@ -.. This is a hack to allow doc references to files in other subdirectories. - -.. include:: ../reference_appendices/config.rst diff --git a/test/sanity/code-smell/docs-build.py b/test/sanity/code-smell/docs-build.py index 614114436d4..bdf3e5027a1 100755 --- a/test/sanity/code-smell/docs-build.py +++ b/test/sanity/code-smell/docs-build.py @@ -20,6 +20,33 @@ def main(): output = warnings_fd.read().strip() lines = output.splitlines() + known_warnings = { + 'block-quote-missing-blank-line': r'^Block quote ends without a blank line; unexpected unindent.$', + 'literal-block-lex-error': r'^Could not lex literal_block as "[^"]*". Highlighting skipped.$', + 'duplicate-label': r'^duplicate label ', + 'undefined-label': r'undefined label: ', + 'unknown-document': r'unknown document: ', + 'toc-tree-missing-document': r'toctree contains reference to nonexisting document ', + 'reference-target-not-found': r'[^ ]* reference target not found: ', + 'not-in-toc-tree': r"document isn't included in any toctree$", + 'unexpected-indentation': r'^Unexpected indentation.$', + 'definition-list-missing-blank-line': r'^Definition list ends without a blank line; unexpected unindent.$', + 'explicit-markup-missing-blank-line': r'Explicit markup ends without a blank line; unexpected unindent.$', + 'toc-tree-glob-pattern-no-match': r"^toctree glob pattern '[^']*' didn't match any documents$", + 'unknown-interpreted-text-role': '^Unknown interpreted text role "[^"]*".$', + } + + ignore_codes = [ + 'literal-block-lex-error', + 'undefined-label', + 'unknown-document', + 'toc-tree-missing-document', + 'reference-target-not-found', + 'not-in-toc-tree', + ] + + used_ignore_codes = set() + for line in lines: match = re.search('^(?P[^:]+):((?P[0-9]+):)?((?P[0-9]+):)? (?PWARNING|ERROR): (?P.*)$', line) @@ -27,11 +54,11 @@ def main(): path = 'docs/docsite/rst/index.rst' lineno = 0 column = 0 - level = 'unknown' + code = 'unknown' message = line # surface unknown lines while filtering out known lines to avoid excessive output - print('%s:%d:%d: %s: %s' % (path, lineno, column, level, message)) + print('%s:%d:%d: %s: %s' % (path, lineno, column, code, message)) continue path = match.group('path') @@ -45,10 +72,32 @@ def main(): if path.startswith(base_dir): path = path[len(base_dir):] + if path.startswith('rst/'): + path = 'docs/docsite/' + path # fix up paths reported relative to `docs/docsite/` + if level == 'warning': - continue + code = 'warning' + + for label, pattern in known_warnings.items(): + if re.search(pattern, message): + code = label + break + else: + code = 'error' + + if code == 'not-in-toc-tree' and path.startswith('docs/docsite/rst/modules/'): + continue # modules are not expected to be in the toc tree + + if code in ignore_codes: + used_ignore_codes.add(code) + continue # ignore these codes + + print('%s:%d:%d: %s: %s' % (path, lineno, column, code, message)) + + unused_ignore_codes = set(ignore_codes) - used_ignore_codes - print('%s:%d:%d: %s: %s' % (path, lineno, column, level, message)) + for code in unused_ignore_codes: + print('test/sanity/code-smell/docs-build.py:0:0: remove `%s` from the `ignore_codes` list as it is no longer needed' % code) if __name__ == '__main__':