59 lines
2.1 KiB
Python
59 lines
2.1 KiB
Python
|
"""
|
||
|
|
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
|
||
|
|
|
||
|
|
from sphinx import version_info as sphinx_version
|
||
|
|
from sphinx.locale import _
|
||
|
|
from sphinx.util.logging import getLogger
|
||
|
|
|
||
|
|
|
||
|
|
__version__ = '0.5.2'
|
||
|
|
__version_full__ = __version__
|
||
|
|
|
||
|
|
logger = getLogger(__name__)
|
||
|
|
|
||
|
|
|
||
|
|
def get_html_theme_path():
|
||
|
|
"""Return list of HTML theme paths."""
|
||
|
|
cur_dir = path.abspath(path.dirname(path.dirname(__file__)))
|
||
|
|
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)
|
||
|
|
|
||
|
|
return {'parallel_read_safe': True, 'parallel_write_safe': True}
|