module datasets.documentation

Short summary

module papierstat.datasets.documentation

Automatatisation de certaines parties de la documentation.

source on GitHub

Functions

function	truncated documentation
list_notebooks	Retourne les notebooks qui contiennent name dans leur nom.
list_notebooks_rst_links	Retourne une liste de notebooks au format rst.

Documentation

Automatatisation de certaines parties de la documentation.

source on GitHub

papierstat.datasets.documentation.list_notebooks(subfolder, name=None, contains=None)

Retourne les notebooks qui contiennent name dans leur nom.

Paramètres:

• subfolder – sous-répertoire où chercher

• name – préfixe à chercher

• contains – extrait à chercher

Renvoie:

liste des notebooks (sans répertoire)

source on GitHub

papierstat.datasets.documentation.list_notebooks_rst_links(subfolder, name=None, contains=None)

Retourne une liste de notebooks au format rst.

Paramètres:

• subfolder – sous-répertoire où chercher

• name – préfixe à chercher

• contains – extrait à chercher

Renvoie:

liste des liens

source on GitHub