module helpgen.stat_helper

Short summary

module pyquickhelper.helpgen.stat_helper

Functions about checking, statistics on files used in the documentation.

source on GitHub

Functions

function

truncated documentation

enumerate_notebooks_link

Looks for all links to a notebook in the documentation.

Documentation

Functions about checking, statistics on files used in the documentation.

source on GitHub

Looks for all links to a notebook in the documentation.

Parameters
  • nb_folder – notebook folder

  • nb_rst – documentation folder

Returns

iterator on (rst_file, nb_file, link type, pos_start, pos_end, string, title)

The function also outputs unreferenced notebooks. rst_file is None in that case.

Example of outputs:

('...index_class.rst', '...having_a_form_in_a_notebook.ipynb', 'ref', 79880, 79912, ':ref:`havingaforminanotebookrst`')
('...index_module.rst', '...having_a_form_in_a_notebook.ipynb', 'ref', 277928, 277960, ':ref:`havingaforminanotebookrst`')

source on GitHub