sphinx_light_release.py

#!/usr/bin/env python3
 
 
 
"""
Create sphinx documentation for a light release and make sure that there are no warnings.
However, a few warnings can not easily be omitted and are therefore accepted for now.
"""
 
import os
import re
from b2test_utils import check_error_free
 
 
if __name__ == "__main__":
 
    
    ignorebackward = '_BACKWARD_BACKWARD_WARNING_H'
    
    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'
    
    ignoretrackmatching = 'trk_matching'
    
    ignoretrackingeventtimeextraction = 'tracking_eventtimeextraction'
 
    sphinx_output_dir = os.getenv("BELLE2_SPHINX_LIGHT_OUTPUTDIR")
    check_error_free(
        "b2code-sphinx-warnings", "sphinx", None,
        lambda x:
        re.findall(ignorebackward, 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) or
        re.findall(ignoretrackmatching, x) or
        re.findall(ignoretrackingeventtimeextraction, x),
        ['--light'] + ["-o", sphinx_output_dir] if sphinx_output_dir else []
    )