election/doc/source/_exts/events.py
Jens Harbott d5945b1920 Fix doc code for updated Sphinx
With Sphinx 4.x, some long deprecated functions have been removed, use
the new replacement instead [0].

[0] https://www.sphinx-doc.org/en/master/extdev/deprecated.html

Change-Id: I07406970f92d9c8917bd26421a394eb48cc39565
2021-08-02 12:20:59 +02:00

40 lines
1.3 KiB
Python

# 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.
"""Add election timer data"""
import os
import jinja2
import jinja2.environment
from sphinx.util import logging
from openstack_election import utils
LOG = logging.getLogger(__name__)
def build_timer(app):
app.add_js_file("event_timer.js")
output_file = os.path.join(".", "doc", "source", "events.rst")
with open(output_file, "w") as out:
template_dir = os.path.join(".", "doc", "source", "_exts")
loader = jinja2.FileSystemLoader(template_dir)
env = jinja2.environment.Environment(trim_blocks=True, loader=loader)
template = env.get_template("events.jinja")
out.write(template.render({'events': utils.conf['timeline']}))
def setup(app):
LOG.info('loading events_timer extension')
app.connect('builder-inited', build_timer)