warnings_filter Namespace Reference

Classes
class	WarningsFilter

Functions
def	configure
def	setup

Variables
string	__version__ "0.1.0"

Detailed Description

(taken from https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/_extensions/zephyr/warnings_filter.py)

Warnings filter extension
#########################

Copyright (c) 2021 Nordic Semiconductor ASA
SPDX-License-Identifier: Apache-2.0

Introduction
============

This Sphinx plugin can be used to filter out warnings that are known to be false
positives. The warnings are filtered out based on a set of regular expressions
given via an configuration file. The format of the configuration file is a
plain-text file where each line consists of a regular expression. Any lines
starting with ``#`` will be ignored.

Configuration options
=====================

- ``warnings_filter_config``: Configuration file.
- ``warnings_filter_silent``: Silent flag. If True, warning is hidden. If False
  the warning is converted to an information message and displayed.

Function Documentation

def warnings_filter.configure

(

app

)

Definition at line 70 of file warnings_filter.py.

View newest version in sPHENIX GitHub at line 70 of file warnings_filter.py

References Acts.open.

Referenced by PHLog.Init().

Here is the caller graph for this function:

def warnings_filter.setup

(

app

)

Definition at line 91 of file warnings_filter.py.

View newest version in sPHENIX GitHub at line 91 of file warnings_filter.py

Variable Documentation

string warnings_filter.__version__ "0.1.0"

Definition at line 35 of file warnings_filter.py.

View newest version in sPHENIX GitHub at line 35 of file warnings_filter.py