Files
openstackdocstheme/openstackdocstheme/__init__.py
Anne Gentle 3e05dffc7b Theme needs a setup function to be used from package
Change-Id: I2212941f09b00f5c0cbc29217fe59cfa408367a0
2015-02-02 16:41:46 -06:00

44 lines
1.7 KiB
Python

# Copyright 2015 Rackspace US, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import os
def builder_inited(app):
theme_dir = os.path.join(os.path.dirname(__file__), 'theme')
app.info('Using openstackdocstheme Sphinx theme from %s' % theme_dir)
# Insert our theme directory at the front of the search path and
# force the theme setting to use the one in the package. This is
# done here, instead of in setup(), because conf.py is read after
# setup() runs, so if the conf contains these values the user
# values overwrite these. That's not bad for the theme, but it
# breaks the search path.
app.config.html_theme_path.insert(0, theme_dir)
# Set the theme name
app.config.html_theme = 'openstackdocstheme'
# Re-initialize the builder, if it has the method for setting up
# the templates and theme.
if hasattr(app.builder, 'init_templates'):
app.builder.init_templates()
def get_html_theme_path():
"""Return the directory containing HTML theme for local builds."""
pkg_dir = os.path.abspath(os.path.dirname(__file__))
return os.path.join(pkg_dir, 'theme')
def setup(app):
app.connect('builder-inited', builder_inited)