module helpgen.sphinx_main_verification

Inheritance diagram of pyquickhelper.helpgen.sphinx_main_verification

Short summary

module pyquickhelper.helpgen.sphinx_main_verification

Function to verify the files produced by Sphinx

source on GitHub

Classes

class

truncated documentation

SphinxVerificationException

to format the error message

Functions

function

truncated documentation

verification_html_file

Verifies a file produced by sphinx and checks basic mistakes.

verification_html_format

dig into folders abd subfolders to find HTML files produced by Sphinx, does some verification to detect errors, …

Methods

method

truncated documentation

__init__

Documentation

Function to verify the files produced by Sphinx

source on GitHub

exception pyquickhelper.helpgen.sphinx_main_verification.SphinxVerificationException(errors)[source][source]

Bases: Exception

to format the error message

source on GitHub

Parameters

errors – errors met

source on GitHub

__init__(errors)[source][source]
Parameters

errors – errors met

source on GitHub

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.

source on GitHub

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

source on GitHub