2ddac026f1
Now that patchqueue was removed, we can consider supporting the parallel read with our local extensions. Since we only have basic extensions, not storing any data on the build environment, the change mainly consists of specifying the extensions as parallelizable. The only specific case is the html domain, since the base html domain requires the support of the method merge_domaindata in parallel read mode. Since we do not need to share anything between the envs for this extension, we can simply ignore the method.
119 lines
3.6 KiB
Python
119 lines
3.6 KiB
Python
"""
|
|
* adds github_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
|
|
========
|
|
|
|
* ``github_user``, username/organisation under which the project lives
|
|
* ``github_project``, name of the project on github
|
|
* (optional) ``version``, github branch to link to (default: master)
|
|
|
|
Notes
|
|
=====
|
|
|
|
* provided ``linkcode_resolve`` only supports Python domain
|
|
* generates https github links
|
|
* explicitly imports ``odoo``, so useless for anyone else
|
|
"""
|
|
|
|
import inspect
|
|
import importlib
|
|
import os.path
|
|
import werkzeug
|
|
|
|
|
|
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 odoo
|
|
# FIXME: make finding project root project-independent
|
|
project_root = os.path.join(os.path.dirname(odoo.__file__), '..')
|
|
return make_github_link(
|
|
app,
|
|
os.path.relpath(obj_source_path, project_root),
|
|
line,
|
|
odoo_repository=True)
|
|
app.config.linkcode_resolve = linkcode_resolve
|
|
|
|
return {
|
|
'parallel_read_safe': True,
|
|
'parallel_write_safe': True
|
|
}
|
|
|
|
def make_github_link(app, path, line=None, mode="blob", odoo_repository=False):
|
|
config = app.config
|
|
|
|
user = config.github_user
|
|
project = config.github_project
|
|
if odoo_repository:
|
|
user = 'odoo'
|
|
project = 'odoo'
|
|
|
|
urlpath = "/{user}/{project}/{mode}/{branch}/{path}".format(
|
|
user=user,
|
|
project=project,
|
|
branch=config.version or 'master',
|
|
path=path,
|
|
mode=mode,
|
|
)
|
|
return werkzeug.urls.url_unparse((
|
|
'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 (.rst) page on github """
|
|
if not app.config.github_user and app.config.github_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 = next(iter(source_suffix))
|
|
context['github_link'] = lambda mode='edit': make_github_link(
|
|
app, 'content/%s%s' % (pagename, source_suffix), mode=mode)
|