deb-oslosphinx/oslosphinx/__init__.py

64 lines
2.3 KiB
Python

# Copyright 2013 New Dream Network, LLC (DreamHost)
#
# 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
import subprocess
import urlparse
CGIT_BASE = 'http://git.openstack.org/cgit/'
_cgit_link = None
def _html_page_context(app, pagename, templatename, context, doctree):
global _cgit_link
if _cgit_link is None:
try:
git_remote = subprocess.check_output(
['git', 'config', '--local', '--get', 'remote.origin.url']
)
except subprocess.CheckedProcessException:
_cgit_link = 'unknown'
else:
parsed = urlparse.urlparse(git_remote)
_cgit_link = CGIT_BASE + parsed.path.lstrip('/')
context['cgit_link'] = _cgit_link
return context
def builder_inited(app):
theme_dir = os.path.join(os.path.dirname(__file__), 'theme')
app.info('Using openstack 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 unless
# another openstack theme is already selected. 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
if not app.config.html_theme.startswith('openstack'):
app.config.html_theme = 'openstack'
# 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()
# Register our page context additions
app.connect('html-page-context', _html_page_context)
def setup(app):
app.connect('builder-inited', builder_inited)