TemplateInfo#
- class scikitplot.cython.TemplateInfo(template_id='', path=PosixPath('.'), meta_path=None, category='', language='', level='', summary='', description='', requires_numpy=False, requires_cpp=False, demo_calls=(), support_paths=(), extra_sources=(), tags=(), schema_version=1, meta=<factory>)[source]#
Structured metadata for a template.
All attributes have defaults to keep Sphinx tooling and linkcode resolvers robust, even when a template has no metadata file.
- Parameters:
- template_idstr
Template identifier (e.g.,
"basic_cython/t01_square_int").- pathpathlib.Path
Path to the template source file.
- meta_pathpathlib.Path or None
Path to the metadata file if found.
- categorystr
Category folder (e.g.,
"basic_cython"), if any.- languagestr
Template language (e.g.,
"cython"or"python").- levelstr
Difficulty or level tag, if present.
- summarystr
Short, single-line summary.
- descriptionstr
Longer description, if present.
- requires_numpybool
Whether template requires NumPy.
- requires_cppbool
Whether template requires C++ mode.
- demo_callstuple[dict[str, Any], …]
Strictly declared demo calls. Each element should resemble:
{"func": "square", "args": [12], "kwargs": {}}.- support_pathstuple[str, …]
Additional source paths to copy into the build directory.
- extra_sourcestuple[str, …]
Extra C/C++ sources to compile and link.
- tagstuple[str, …]
Optional tags for docs/search.
- schema_versionint
Metadata schema version.
- metaMapping[str, Any]
Raw metadata mapping (full JSON), for advanced use.
- Parameters: