project-config/docs-site/generate_infra_index.py
Hervé Beraud 95c01abf38 Stop to use the __future__ module.
The __future__ module [1] was used in this context to ensure compatibility
between python 2 and python 3.

We previously dropped the support of python 2.7 [2] and now we only support
python 3 so we don't need to continue to use this module and the imports
listed below.

Imports commonly used and their related PEPs:
- `division` is related to PEP 238 [3]
- `print_function` is related to PEP 3105 [4]
- `unicode_literals` is related to PEP 3112 [5]
- `with_statement` is related to PEP 343 [6]
- `absolute_import` is related to PEP 328 [7]

[1] https://docs.python.org/3/library/__future__.html
[2] https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html
[3] https://www.python.org/dev/peps/pep-0238
[4] https://www.python.org/dev/peps/pep-3105
[5] https://www.python.org/dev/peps/pep-3112
[6] https://www.python.org/dev/peps/pep-0343
[7] https://www.python.org/dev/peps/pep-0328

Change-Id: Icc115b2271a6fd84f3952b03406250367babd273
2020-06-02 20:44:50 +02:00

62 lines
1.8 KiB
Python
Executable File

#!/usr/bin/env 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.
"""Read the infra-documents.yaml file and generate the index.html file.
"""
import argparse
import os
import jinja2
import yaml
def render_template(template_filename, output_filename, template_context):
with open(template_filename, 'r') as f:
template = jinja2.Template(f.read())
print('Writing %r' % output_filename)
with open(output_filename, 'w') as f:
f.write(template.render(**template_context))
parser = argparse.ArgumentParser()
parser.add_argument('-v', '--verbose',
dest='verbose',
default=False,
action='store_true',
)
parser.add_argument(
'infile',
help='Path to infra-documents.yaml',
)
args = parser.parse_args()
print('Reading documents data from %r' % args.infile)
infile = yaml.safe_load(open(args.infile, 'r'))
template_path = os.path.dirname(args.infile)
template_context = {
'documents': infile['documents'],
'all': infile['documents']
}
outdir = os.path.join(template_path, 'html')
if not os.path.exists(outdir):
os.makedirs(outdir)
for template_name, filename in [('infra-index.html.tmpl', 'index.html')]:
render_template(os.path.join(template_path, template_name),
os.path.join(outdir, filename),
template_context)