Class ConfigtraitFilter

docs/source/conf.py:126–138

This is a filter to remove in sphinx 3+ the error about config traits being duplicated. As we autogenerate configuration traits from, subclasses have lots of duplication and we want to silence them. Indeed we build on travis with warnings-as-error set to True, so those duplicate i

import logging

class ConfigtraitFilter(logging.Filter):
    """
    This is a filter to remove in sphinx 3+ the error about config traits being duplicated. 

    As we autogenerate configuration traits from, subclasses have lots of
    duplication and we want to silence them. Indeed we build on travis with
    warnings-as-error set to True, so those duplicate items make the build fail.
    """

    def filter(self, record):
        if record.args and record.args[0] == 'configtrait' and 'duplicate' in record.msg:
            return False
        return True

ct_filter = ConfigtraitFilter()