diff options
Diffstat (limited to 'sphinx/jinja2glue.py')
| -rw-r--r-- | sphinx/jinja2glue.py | 81 |
1 files changed, 32 insertions, 49 deletions
diff --git a/sphinx/jinja2glue.py b/sphinx/jinja2glue.py index 0c7c5d72..fc3efc01 100644 --- a/sphinx/jinja2glue.py +++ b/sphinx/jinja2glue.py @@ -18,63 +18,31 @@ from sphinx.util import mtimes_of_files from sphinx.application import TemplateBridge -class SphinxLoader(jinja2.BaseLoader): +class BuiltinTemplateLoader(TemplateBridge, jinja2.BaseLoader): """ - A jinja2 reimplementation of `sphinx._jinja.SphinxFileSystemLoader`. + Interfaces the rendering environment of jinja2 for use in Sphinx. """ - def __init__(self, basepath, extpaths, encoding='utf-8'): - """ - Create a new loader for sphinx. + # TemplateBridge interface - *extpaths* is a list of directories, which provide additional templates - to sphinx. - - *encoding* is used to decode the templates into unicode strings. - Defaults to utf-8. - - If *basepath* is set, this path is used to load sphinx core templates. - If False, these templates are loaded from the sphinx package. - """ - self.core_loader = jinja2.FileSystemLoader(basepath) - self.all_loaders = jinja2.ChoiceLoader( - [jinja2.FileSystemLoader(extpath) for extpath in extpaths] + - [self.core_loader]) + def init(self, builder): + self.theme = builder.theme + # create a chain of paths to search: + # the theme's own dir and its bases' dirs + chain = self.theme.get_dirchain() + # then the theme parent paths (XXX doc) + chain.extend(self.theme.themepath) - def get_source(self, environment, template): - # exclamation mark forces loading from core - if template.startswith('!'): - return self.core_loader.get_source(environment, template[1:]) - # check if the template is probably an absolute path - fs_path = template.replace('/', path.sep) - if path.isabs(fs_path): - if not path.exists(fs_path): - raise jinja2.TemplateNotFound(template) - f = codecs.open(fs_path, 'r', self.encoding) - try: - mtime = path.getmtime(path) - return (f.read(), fs_path, - lambda: mtime == path.getmtime(path)) - finally: - f.close() - # finally try to load from custom templates - return self.all_loaders.get_source(environment, template) + # prepend explicit template paths + if builder.config.templates_path: + chain[0:0] = builder.config.templates_path + # make the paths into loaders + self.loaders = map(jinja2.FileSystemLoader, chain) -class BuiltinTemplates(TemplateBridge): - """ - Interfaces the rendering environment of jinja2 for use in sphinx. - """ - - def init(self, builder): - base_templates_path = path.join(path.dirname(__file__), 'templates') - ext_templates_path = [path.join(builder.confdir, dir) - for dir in builder.config.templates_path] - self.templates_path = [base_templates_path] + ext_templates_path - loader = SphinxLoader(base_templates_path, ext_templates_path) use_i18n = builder.translator is not None extensions = use_i18n and ['jinja2.ext.i18n'] or [] - self.environment = jinja2.Environment(loader=loader, + self.environment = jinja2.Environment(loader=self, extensions=extensions) if use_i18n: self.environment.install_gettext_translations(builder.translator) @@ -83,4 +51,19 @@ class BuiltinTemplates(TemplateBridge): return self.environment.get_template(template).render(context) def newest_template_mtime(self): - return max(mtimes_of_files(self.templates_path, '.html')) + return max(mtimes_of_files(self.theme.themepath, '.html')) + + # Loader interface + + def get_source(self, environment, template): + loaders = self.loaders + # exclamation mark starts search from base + if template.startswith('!'): + loaders = loaders[1:] + template = template[1:] + for loader in loaders: + try: + return loader.get_source(environment, template) + except jinja2.TemplateNotFound: + pass + raise jinja2.TemplateNotFound(template) |