render_resource_tree

函数源码

render_resource_tree(
    out_dir: str | PathLike[str],
    variables: dict,
    package: str = "pydocusaurus",
    resource_root: str = "resources",
    saver: SaverAbstract | None = None,
)

渲染某个模块包的资源树。

将递归地加载模块包中的资源文件夹。其中 Jinja2 模板文件将渲染为输出文件，非模板的普通文件则原样复制，按照资源文件夹的结构原样重构到out_dir中。

参数

输入

参数	类型	必选	说明
out_dir	str | PathLike[str]		资源文件夹将要导出的目录路径。
variables	dict		从变量名称到变量值的映射。该字典将传入 Jinja2 模板中，以用来参数化渲染文件。
package	str		包含资源的模块包名称。
resource_root	str		模块包内部的资源文件夹、相对于模块包的根目录的路径。例如，可能是"resources/ts"。
saver	SaverAbstract | None		用来导出输出文件的保存器。若未指定，则会使用默认的保存器。