Skip to main content

resources

ModuleSource

Rendering the resource files into the documentation.

This module manages the files in the resource folder. These files are not a part of the codes but provide the templates and the files to be rendered as typescripts in the exported documentation.

Functions

Member
Description
is_jinja_templateCheck whether the file is a jinja2 template.
get_jinja_template_out_nameGet the destination name of the file rendered from a jinja2 template file.
ts_objectDump a value as json, and put it in a typescript object.
as_pypi_nameConvert the package name as a PyPI name.
render_resource_treeRender the resource tree of a package.