election/doc/source/_exts/events.py
Tristan Cacqueray e7f05ce2c4 Add events timeline and clock timer
This changes add a new 'events' extensions to manage
events timeline. Events are described in the events.yaml file.

The 'events' extensions will generate an rst document with:
* Timer clock for upcoming event
* Tabulated events list

Change-Id: Ib5c9d96663bd2197beea7aab226a3d46bc82067c
2016-02-24 10:47:54 +11:00

46 lines
1.6 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 yaml
from jinja2 import FileSystemLoader
from jinja2.environment import Environment
from docutils import nodes
PATH_PREFIX = 'candidates'
def build_timer(app):
app.add_javascript("event_timer.js")
data = yaml.load(open("events.yaml").read())
# add better text for tabulatted planning
for ev in data:
d, h = ev['date'].split('T')
ev['date_str'] = "%s, %s UTC" % (d, h)
output_file = os.path.join(PATH_PREFIX, "events.rst")
with open(output_file, "w") as out:
template_dir = os.path.join(".", "doc", "source", "_exts")
loader = FileSystemLoader(template_dir)
env = Environment(trim_blocks=True, loader=loader)
template = env.get_template("events.jinja")
out.write(template.render({'events':data}))
def setup(app):
if not os.path.isfile("events.yaml"):
app.info('No events.yaml found, not loading events_timer extension')
return
app.info('loading events_timer extension')
app.connect('builder-inited', build_timer)