diff --git a/docs/source/_ext/edit_on_github.py b/docs/source/_ext/edit_on_github.py index cb6a45f058a..eef249a3f01 100644 --- a/docs/source/_ext/edit_on_github.py +++ b/docs/source/_ext/edit_on_github.py @@ -13,13 +13,11 @@ __licence__ = 'BSD (3 clause)' def get_github_url(app, view, path): + github_fmt = 'https://github.com/{}/{}/{}/{}{}' return ( - 'https://github.com/{project}/{view}/{branch}/{src_path}{path}'.format( - project=app.config.edit_on_github_project, - view=view, - branch=app.config.edit_on_github_branch, - src_path=app.config.edit_on_github_src_path, - path=path)) + github_fmt.format(app.config.edit_on_github_project, view, + app.config.edit_on_github_branch, + app.config.edit_on_github_src_path, path)) def html_page_context(app, pagename, templatename, context, doctree): diff --git a/docs/source/conf.py b/docs/source/conf.py index 66bce1e895a..18b14795caa 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -17,20 +17,21 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # -import sys, os -from os.path import relpath, dirname +import sys +import os +from os.path import relpath import inspect +from homeassistant.const import (__version__, __short_version__, PROJECT_NAME, + PROJECT_LONG_DESCRIPTION, + PROJECT_COPYRIGHT, PROJECT_AUTHOR, + PROJECT_GITHUB_USERNAME, + PROJECT_GITHUB_REPOSITORY, + GITHUB_PATH, GITHUB_URL) + sys.path.insert(0, os.path.abspath('_ext')) sys.path.insert(0, os.path.abspath('../homeassistant')) -from homeassistant.const import (__version__, __short_version__, PROJECT_NAME, - PROJECT_LONG_DESCRIPTION, PROJECT_URL, - PROJECT_COPYRIGHT, PROJECT_AUTHOR, - PROJECT_GITHUB_USERNAME, - PROJECT_GITHUB_REPOSITORY, PYPI_URL, - GITHUB_PATH, GITHUB_URL) - # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. @@ -84,6 +85,7 @@ edit_on_github_project = GITHUB_PATH edit_on_github_branch = code_branch edit_on_github_src_path = 'docs/source/' + def linkcode_resolve(domain, info): """ Determine the URL corresponding to Python object