From 2601b782e339ab0725858346918699f3da913732 Mon Sep 17 00:00:00 2001 From: David Garcia Date: Fri, 31 Mar 2023 16:06:38 +0100 Subject: [PATCH] docs: update conf.py docs: test docs: add skip warnings option --- docs/source/conf.py | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index d0480897398..7cdfc2eca6a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -3,7 +3,6 @@ import os from datetime import date import re -import warnings from docutils import nodes from recommonmark.transform import AutoStructify from recommonmark.parser import CommonMarkParser, splitext, urlparse @@ -116,6 +115,7 @@ 'versions_unstable': UNSTABLE_VERSIONS, 'versions_deprecated': DEPRECATED_VERSIONS, 'hide_version_dropdown': ['scylla-3.x'], + 'skip_warnings': 'document_has_underscores' } # If not None, a 'Last updated on:' timestamp is inserted at every page @@ -171,12 +171,6 @@ def replace_relative_links(app, docname, source): source[0] = result -def build_inited(app): - warnings.filterwarnings( - action="ignore", - message=r".*Document name contains underscores:.*", - ) - def build_finished(app, exception): version_name = os.getenv("SPHINX_MULTIVERSION_NAME", "") version_name = "/" + version_name if version_name else "" @@ -185,9 +179,6 @@ def build_finished(app, exception): redirects_cli.create(redirect_to=redirect_to,out_file=out_file) def setup(app): - # Filter warnings - app.connect('builder-inited', build_inited) - # Setup Markdown parser app.add_source_parser(CustomCommonMarkParser) app.add_config_value('recommonmark_config', { @@ -207,4 +198,4 @@ def setup(app): # Create redirect to JavaDoc API app.connect('build-finished', build_finished) - \ No newline at end of file +