module helpgen.sphinx_main_verification
¶
Short summary¶
module pyquickhelper.helpgen.sphinx_main_verification
Function to verify the files produced by Sphinx
Classes¶
class |
truncated documentation |
---|---|
to format the error message |
Functions¶
function |
truncated documentation |
---|---|
Verifies a file produced by sphinx and checks basic mistakes. |
|
dig into folders abd subfolders to find HTML files produced by Sphinx, does some verification to detect errors, … |
Documentation¶
Function to verify the files produced by Sphinx
-
exception
pyquickhelper.helpgen.sphinx_main_verification.
SphinxVerificationException
(errors)[source][source]¶ Bases:
Exception
to format the error message
- Parameters
errors – errors met
-
pyquickhelper.helpgen.sphinx_main_verification.
verification_html_file
(item, fLOG=<function noLOG>)[source][source]¶ Verifies a file produced by sphinx and checks basic mistakes.
- Parameters
item – filename
fLOG – logging function
- Returns
list of errors (line, message)
The first line is 0.
-
pyquickhelper.helpgen.sphinx_main_verification.
verification_html_format
(folder, fLOG=<function noLOG>, raise_above=0.1)[source][source]¶ dig into folders abd subfolders to find HTML files produced by Sphinx, does some verification to detect errors, the function, the function raises an exception for all mistakes
- Parameters
folder – folder to verifiy
fLOG – logging function
raise_above – raises an exception of the number of errors is above a given threshold or a relative threshold if it is a float
- Returns
list of errors