module __init__
¶
Short summary¶
module pyquickhelper
Module pyquickhelper. Helpers to produce documentation, test notebooks, walk through files, sphinx extension, jenkins helpers…
Functions¶
function |
truncated documentation |
---|---|
if this function is added to the module, the help automation and unit tests call it first before anything goes on … |
|
Checks the library is working. It raises an exception if it does not. |
|
return a logging function |
|
Returns function used when a module includes C++ parts. |
|
to allow the call |
Documentation¶
Module pyquickhelper. Helpers to produce documentation, test notebooks, walk through files, sphinx extension, jenkins helpers…
-
pyquickhelper.
_setup_hook
(add_print=False, unit_test=False)[source]¶ if this function is added to the module, the help automation and unit tests call it first before anything goes on as an initialization step. It should be run in a separate process.
- Parameters
add_print – print Success: _setup_hook
unit_test – used only for unit testing purpose
-
pyquickhelper.
check
()[source]¶ Checks the library is working. It raises an exception if it does not.
- Returns
boolean
-
pyquickhelper.
get_fLOG
(log=True)[source]¶ return a logging function
- Parameters
log – True, return
fLOG
, otherwisenoLOG()
- Returns
function
-
pyquickhelper.
get_insetup_functions
()[source]¶ Returns function used when a module includes C++ parts.
- Returns
tuple of functions