sphinx.py

#!/usr/bin/env python3
 
 
 
"""
Create sphinx documentation and make sure that there are no warnings.
However, a few warnings can not easily be omitted and are therefore accepted for now.
"""
 
import re
from b2test_utils import check_error_free
 
 
light_build = False
try:
    import generators  # noqa
except ModuleNotFoundError:
    light_build = True
 
if __name__ == "__main__":
    
    ignoreenvironmentvariables = 'envvar'
    
    ignorepythonclass = 'py:class reference target not found'
    
    ignoreduplicatewhatsnewlabel = 'duplicate label whatsnew:'
    
    ignoreduplicatedescriptionofrole = 'duplicate description of role'
    
    ignoreonlinebook = 'online_book'
    
    ignoreaddtriggersimulation = 'add_trigger_simulation'
    
    ignoreaddsimulation = 'add_simulation'
    
    ignoreaddreconstruction = 'add_reconstruction'
    
    ignoreaddcdstoutput = 'add_cdst_output'
    
    ignorevalidationtools = 'validation_tools'
    
    ignoreincludeproblem = 'Problems with "include" directive path'
 
    check_error_free("b2code-sphinx-warnings", "sphinx", None,
                     lambda x:
                     re.findall(ignoreenvironmentvariables, x) or
                     re.findall(ignorepythonclass, x) or
                     re.findall(ignoreduplicatewhatsnewlabel, x) or
                     re.findall(ignoreduplicatedescriptionofrole, x) or
                     re.findall(ignoreaddsimulation, x) or
                     re.findall(ignoreaddtriggersimulation, x) or
                     re.findall(ignoreaddreconstruction, x) or
                     re.findall(ignoreaddcdstoutput, x) or
                     re.findall(ignorevalidationtools, x) or
                     re.findall(ignoreincludeproblem, x) or
                     re.findall(ignoreonlinebook, x),
                     ['--light']
                     )
    if not light_build:
        check_error_free("b2code-sphinx-warnings", "sphinx", None,
                         lambda x:
                         re.findall(ignoreenvironmentvariables, x) or
                         re.findall(ignorepythonclass, x) or
                         re.findall(ignoreduplicatewhatsnewlabel, x) or
                         re.findall(ignoreduplicatedescriptionofrole, x)
                         )