generate_sphinx_template_docs

scikitplot.cython.generate_sphinx_template_docs(output_dir, *, title='Cython templates', include_python=True, include_cython=True)

Generate Sphinx .rst pages listing templates and their usage.

This function does not import any .pyx code. It uses metadata files and literalinclude directives to embed source text.

Parameters:

output_dirstr or pathlib.Path

Output directory for generated .rst files.

titlestr, default=’Cython templates’

Title used for the index page.

include_pythonbool, default=True

Include Python templates.

include_cythonbool, default=True

Include Cython templates.

Returns:

list[pathlib.Path]

Paths of generated .rst files.

Parameters:

• output_dir (str | Path)

• title (str)

• include_python (bool)

• include_cython (bool)

Return type:

list[Path]