diff options
| author | Xavier Morel <xmo@odoo.com> | 2015-07-06 17:39:19 +0200 |
|---|---|---|
| committer | Xavier Morel <xmo@odoo.com> | 2015-07-07 11:22:50 +0200 |
| commit | 95e56a109d5abc97ab7db1ee1c9b9efb66a7e362 (patch) | |
| tree | eed458208184022af42b119d9c26219716c67fab /doc/_themes/odoodoc/github.py | |
| parent | b4efb4eeb3e0e7b27a113ad914d5a18e50f8718d (diff) | |
[ADD] doc: new theme
Pretty much completely rewritten theme with custom HTML translator and a
few parts of the old theme extracted to their own extensions.
Banner images thought not to be that huge after all, and not worth the
hassle of them living in a different repository.
co-authored with @stefanorigano
Diffstat (limited to 'doc/_themes/odoodoc/github.py')
| -rw-r--r-- | doc/_themes/odoodoc/github.py | 77 |
1 files changed, 0 insertions, 77 deletions
diff --git a/doc/_themes/odoodoc/github.py b/doc/_themes/odoodoc/github.py deleted file mode 100644 index 4c5087b60ab..00000000000 --- a/doc/_themes/odoodoc/github.py +++ /dev/null @@ -1,77 +0,0 @@ -import inspect -import importlib -import os.path -from urlparse import urlunsplit - -def setup(app): - app.add_config_value('github_user', None, 'env') - app.add_config_value('github_project', None, 'env') - app.connect('html-page-context', add_doc_link) - - def linkcode_resolve(domain, info): - """ Resolves provided object to corresponding github URL - """ - # TODO: js? - if domain != 'py': - return None - if not (app.config.github_user and app.config.github_project): - return None - - module, fullname = info['module'], info['fullname'] - # TODO: attributes/properties don't have modules, maybe try to look - # them up based on their cached host object? - if not module: - return None - - obj = importlib.import_module(module) - for item in fullname.split('.'): - obj = getattr(obj, item, None) - - if obj is None: - return None - - # get original from decorated methods - try: obj = getattr(obj, '_orig') - except AttributeError: pass - - try: - obj_source_path = inspect.getsourcefile(obj) - _, line = inspect.getsourcelines(obj) - except (TypeError, IOError): - # obj doesn't have a module, or something - return None - - import openerp - project_root = os.path.join(os.path.dirname(openerp.__file__), '..') - return make_github_link( - app, - os.path.relpath(obj_source_path, project_root), - line) - app.config.linkcode_resolve = linkcode_resolve - -def make_github_link(app, path, line=None, mode="blob"): - config = app.config - - urlpath = "/{user}/{project}/{mode}/{branch}/{path}".format( - user=config.github_user, - project=config.github_project, - branch=config.version or 'master', - path=path, - mode=mode, - ) - return urlunsplit(( - 'https', - 'github.com', - urlpath, - '', - '' if line is None else 'L%d' % line - )) - -def add_doc_link(app, pagename, templatename, context, doctree): - """ Add github_link function linking to the current page on github """ - if not app.config.github_user and app.config.github_project: - return - - # can't use functools.partial because 3rd positional is line not mode - context['github_link'] = lambda mode='mode': make_github_link( - app, 'doc/%s%s' % (pagename, app.config.source_suffix), mode=mode) |
