diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 9131c4d..d3056fb 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -13,7 +13,9 @@ repos: rev: 20.8b1 hooks: - id: black + exclude: ^docs/ - repo: https://github.com/pycqa/isort rev: 5.6.3 hooks: - id: isort + exclude: ^docs/ diff --git a/docs/source/_themes/custom_theme/__init__.py b/docs/source/_themes/custom_theme/__init__.py index 2d77c02..077591d 100644 --- a/docs/source/_themes/custom_theme/__init__.py +++ b/docs/source/_themes/custom_theme/__init__.py @@ -1,13 +1,21 @@ -"""Sphinx ReadTheDocs theme. +""" +Sphinx Read the Docs theme. From https://github.com/ryan-roemer/sphinx-bootstrap-theme. - """ + from os import path +from sys import version_info as python_version -__version__ = "0.4.1" +from sphinx import version_info as sphinx_version +from sphinx.locale import _ +from sphinx.util.logging import getLogger + +__version__ = "1.0.0" __version_full__ = __version__ +logger = getLogger(__name__) + def get_html_theme_path(): """Return list of HTML theme paths.""" @@ -15,6 +23,39 @@ def get_html_theme_path(): return cur_dir +def config_initiated(app, config): + theme_options = config.html_theme_options or {} + if theme_options.get("canonical_url"): + logger.warning(_("The canonical_url option is deprecated, use the html_baseurl option from Sphinx instead.")) + + # See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package def setup(app): + if python_version[0] < 3: + logger.warning("Python 2 is deprecated with sphinx_rtd_theme, update to Python 3") + app.require_sphinx("1.6") + if sphinx_version <= (2, 0, 0): + logger.warning("Sphinx 1.x is deprecated with sphinx_rtd_theme, update to Sphinx 2.x or greater") + if not app.config.html_experimental_html5_writer: + logger.warning("'html4_writer' is deprecated with sphinx_rtd_theme") + else: + if app.config.html4_writer: + logger.warning("'html4_writer' is deprecated with sphinx_rtd_theme") + + # 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 >= (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) + app.connect("config-inited", config_initiated) + + # sphinx emits the permalink icon for headers, so choose one more in keeping with our theme + if sphinx_version >= (3, 5, 0): + app.config.html_permalinks_icon = "\uf0c1" + else: + app.config.html_add_permalinks = "\uf0c1" + + return {"parallel_read_safe": True, "parallel_write_safe": True} diff --git a/docs/source/_themes/custom_theme/breadcrumbs.html b/docs/source/_themes/custom_theme/breadcrumbs.html index 31550d8..005b2ec 100644 --- a/docs/source/_themes/custom_theme/breadcrumbs.html +++ b/docs/source/_themes/custom_theme/breadcrumbs.html @@ -1,82 +1,77 @@ -{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #} +{%- if meta is defined and meta is not none %} + {%- set check_meta = True %} +{%- else %} + {%- set check_meta = False %} +{%- endif %} -{% if page_source_suffix %} -{% set suffix = page_source_suffix %} -{% else %} -{% set suffix = source_suffix %} -{% endif %} +{%- if check_meta and 'github_url' in meta %} + {%- set display_github = True %} +{%- endif %} -{% if meta is defined and meta is not none %} -{% set check_meta = True %} -{% else %} -{% set check_meta = False %} -{% endif %} +{%- if check_meta and 'bitbucket_url' in meta %} + {%- set display_bitbucket = True %} +{%- endif %} -{% if check_meta and 'github_url' in meta %} -{% set display_github = True %} -{% endif %} +{%- if check_meta and 'gitlab_url' in meta %} + {%- set display_gitlab = 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 %} - -