diff --git a/doc/_themes/sphinx_rtd_theme/__init__.py b/doc/_themes/sphinx_rtd_theme/__init__.py index 88ddcce2..e48d9696 100644 --- a/doc/_themes/sphinx_rtd_theme/__init__.py +++ b/doc/_themes/sphinx_rtd_theme/__init__.py @@ -1,17 +1,34 @@ -"""Sphinx ReadTheDocs theme. +""" +Sphinx Read the Docs theme. From https://github.com/ryan-roemer/sphinx-bootstrap-theme. - """ -import os -VERSION = (0, 1, 9) +from os import path -__version__ = ".".join(str(v) for v in VERSION) +import sphinx + + +__version__ = '0.5.0' __version_full__ = __version__ def get_html_theme_path(): """Return list of HTML theme paths.""" - cur_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__))) + cur_dir = path.abspath(path.dirname(path.dirname(__file__))) return cur_dir + + +# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package +def setup(app): + if sphinx.version_info >= (1, 6, 0): + # Register the theme that can be referenced without adding a theme path + app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__))) + + if sphinx.version_info >= (1, 8, 0): + # Add Sphinx message catalog for newer versions of Sphinx + # See http://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_message_catalog + rtd_locale_path = path.join(path.abspath(path.dirname(__file__)), 'locale') + app.add_message_catalog('sphinx', rtd_locale_path) + + return {'parallel_read_safe': True, 'parallel_write_safe': True} diff --git a/doc/_themes/sphinx_rtd_theme/breadcrumbs.html b/doc/_themes/sphinx_rtd_theme/breadcrumbs.html index 7c2ce5c8..cf64d154 100644 --- a/doc/_themes/sphinx_rtd_theme/breadcrumbs.html +++ b/doc/_themes/sphinx_rtd_theme/breadcrumbs.html @@ -1,31 +1,84 @@ {# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #} -{% if page_source_suffix %} +{% if page_source_suffix %} {% set suffix = page_source_suffix %} {% else %} {% set suffix = source_suffix %} {% endif %} +{% if meta is defined and meta is not none %} +{% set check_meta = True %} +{% else %} +{% set check_meta = False %} +{% endif %} + +{% if check_meta and 'github_url' in meta %} +{% set display_github = True %} +{% endif %} + +{% if check_meta and 'bitbucket_url' in meta %} +{% set display_bitbucket = True %} +{% endif %} + +{% if check_meta and 'gitlab_url' in meta %} +{% set display_gitlab = True %} +{% endif %} + +{% set display_vcs_links = display_vcs_links if display_vcs_links is defined else True %} +
diff --git a/doc/_themes/sphinx_rtd_theme/footer.html b/doc/_themes/sphinx_rtd_theme/footer.html index f4396eec..e1b99c5a 100644 --- a/doc/_themes/sphinx_rtd_theme/footer.html +++ b/doc/_themes/sphinx_rtd_theme/footer.html @@ -1,11 +1,11 @@