module helpgen.sphinx_helper

Short summary

module pyquickhelper.helpgen.sphinx_helper

Various helpers for Sphinx.

source on GitHub

Functions

function	truncated documentation
everything_but_python	Returns True if __pycache__ is not in filename.
post_process_html_nb_output_static_file	post process the HTML files produced by Sphinx to adjust the static files in notebooks (IPython static files do have …
sphinx_add_scripts	copy additional scripts to a folder for sphinx documentation

Documentation

Various helpers for Sphinx.

source on GitHub

pyquickhelper.helpgen.sphinx_helper.everything_but_python(fullname)

Returns True if __pycache__ is not in filename.

source on GitHub

pyquickhelper.helpgen.sphinx_helper.post_process_html_nb_output_static_file(build, fLOG=<function noLOG>)

post process the HTML files produced by Sphinx to adjust the static files in notebooks (IPython static files do have the same paths as Sphinx static files)

Parameters:

• build – build location

• fLOG – logging function

Returns:

list of modified files

Static path in IPython start by /static, they start by ../_static or /_static in Sphinx.

source on GitHub

pyquickhelper.helpgen.sphinx_helper.sphinx_add_scripts(source, dest, filter=<function everything_but_python>, fLOG=<function fLOG>)

copy additional scripts to a folder for sphinx documentation

Parameters:

• source – source

• dest – destination folder (will be created if it does not exists)

• filter – synchronize_folder

• fLOG – logging function

Returns:

synchronize_folder

source on GitHub