flectra/doc/_extensions/gitlab_link.py

import inspect
import importlib
import os.path

from werkzeug import urls

from flectra.tools import pycompat

"""
* adds gitlab_link(mode) context variable: provides URL (in relevant mode) of
  current document on github
* if sphinx.ext.linkcode is enabled, automatically generates github linkcode
  links (by setting config.linkcode_resolve)

Settings
========

* ``gitlab_user``, username/organisation under which the project lives
* ``gitlab_project``, name of the project on gitlab
* (optional) ``version``, gitlab branch to link to (default: master)

Notes
=====

* provided ``linkcode_resolve`` only supports Python domain
* generates https gitlab links
* explicitly imports ``flectra``, so useless for anyone else
"""

def setup(app):
    app.add_config_value('gitlab_user', None, 'env')
    app.add_config_value('gitlab_project', None, 'env')
    app.connect('html-page-context', add_doc_link)

    def linkcode_resolve(domain, info):
        """ Resolves provided object to corresponding gitlab URL
        """
        # TODO: js?
        if domain != 'py':
            return None
        if not (app.config.gitlab_user and app.config.gitlab_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 flectra
        # FIXME: make finding project root project-independent
        project_root = os.path.join(os.path.dirname(flectra.__file__), '..')
        return make_gitlab_link(
            app,
            os.path.relpath(obj_source_path, project_root),
            line)
    app.config.linkcode_resolve = linkcode_resolve

def make_gitlab_link(app, path, line=None, mode="blob"):
    config = app.config

    urlpath = "/{user}/{project}/{mode}/{branch}/{path}".format(
        user=config.gitlab_user,
        project=config.gitlab_project,
        branch=config.version or 'master',
        path=path,
        mode=mode,
    )
    return urls.url_unparse((
        'https',
        'gitlab.com',
        urlpath,
        '',
        '' if line is None else 'L%d' % line
    ))

def add_doc_link(app, pagename, templatename, context, doctree):
    """ Add gitlab_link function linking to the current page on gitlab """
    if not app.config.gitlab_user and app.config.gitlab_project:
        return

    # FIXME: find other way to recover current document's source suffix
    # in Sphinx 1.3 it's possible to have mutliple source suffixes and that
    # may be useful in the future
    source_suffix = app.config.source_suffix
    source_suffix = source_suffix if isinstance(source_suffix, pycompat.string_types) else source_suffix[0]
    # can't use functools.partial because 3rd positional is line not mode
    context['github_link'] = lambda mode='edit': make_gitlab_link(
        app, 'doc/%s%s' % (pagename, source_suffix), mode=mode)