get_template_dir

documenteer.conf.utils.get_template_dir(root)

Get the absolute path for a Documenteer template directory, for use with Sphinx’s templates_path.

Parameters:

root (str) – A root directory for the templates. For example, pydata is the root for templates that override the pydata theme.

Returns:

absolute_path – An absolute path to the templates directory, for use with the templates_path Sphinx configuration.

Return type:

str

Examples

templates_path = [get_template_dir("pydata")]