module helpgen.sphinx_main_missing_html_files

Short summary

module pyquickhelper.helpgen.sphinx_main_missing_html_files

function around missing file for the documentation

source on GitHub

Functions

function

truncated documentation

add_missing_files

Adds missing files for the documentation, moduletoc.html, blogtoc.html, searchbox.html.

extract_first_title

Extracts the first title (rst format) in a file.

Documentation

function around missing file for the documentation

source on GitHub

pyquickhelper.helpgen.sphinx_main_missing_html_files.add_missing_files(root, conf, blog_list, fLOG)[source][source]

Adds missing files for the documentation, moduletoc.html, blogtoc.html, searchbox.html.

Parameters
  • root – root

  • conf – configuration module (to guess the template folder)

  • blog_list – list of recent blog posts to add to the navigational bar (list) or a name for a placeholder (such as __INSERT__)

  • theme – theme, missing files depend on it

  • fLOG – logging function

Returns

list of modified files

The function considers the theme for the searchbox. sphinx_rtd_theme has a different style for the searchbox.

source on GitHub

pyquickhelper.helpgen.sphinx_main_missing_html_files.extract_first_title(filename, underline='=')[source][source]

Extracts the first title (rst format) in a file.

Parameters
  • filename – filename

  • underline – level of the title

Returns

title name (or raises an exception if not found)

source on GitHub