nghttp2/doc/_themes/sphinx_rtd_theme/__init__.py

64 lines
2.3 KiB
Python
Raw Normal View History

2020-07-24 13:18:59 +02:00
"""
Sphinx Read the Docs theme.
2013-12-06 17:27:56 +01:00
From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
"""
2020-07-24 13:18:59 +02:00
from os import path
2022-07-12 15:23:12 +02:00
from sys import version_info as python_version
2020-07-24 13:18:59 +02:00
2022-07-12 15:23:12 +02:00
from sphinx import version_info as sphinx_version
from sphinx.locale import _
from sphinx.util.logging import getLogger
2020-07-24 13:18:59 +02:00
2013-12-06 17:27:56 +01:00
2022-07-12 15:23:12 +02:00
__version__ = '1.0.1alpha1'
2013-12-06 17:27:56 +01:00
__version_full__ = __version__
2022-07-12 15:23:12 +02:00
logger = getLogger(__name__)
2013-12-06 17:27:56 +01:00
def get_html_theme_path():
"""Return list of HTML theme paths."""
2020-07-24 13:18:59 +02:00
cur_dir = path.abspath(path.dirname(path.dirname(__file__)))
2013-12-06 17:27:56 +01:00
return cur_dir
2020-07-24 13:18:59 +02:00
2022-07-12 15:23:12 +02:00
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.')
)
2020-07-24 13:18:59 +02:00
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
def setup(app):
2022-07-12 15:23:12 +02:00
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):
2020-07-24 13:18:59 +02:00
# 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)
2022-07-12 15:23:12 +02:00
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"
2020-07-24 13:18:59 +02:00
return {'parallel_read_safe': True, 'parallel_write_safe': True}