[OpenStack-docs] [doc-tools] Switching to jinja for automated file generation

Gauvain Pocentek gauvain.pocentek at objectif-libre.com
Mon Nov 9 05:45:54 UTC 2015


Hi,

We have several scripts in openstack-doc-tools that generate files 
(openstack-auto-commands, autohelp.py and related tools). These scripts 
either use lxml or `print` statements to build the output. Updates are 
often painful, and the migration to RST will probably not make things 
easier.

I've updated diff_branches.py to use jinja templating instead of lxml 
as a POC, and I'm quite happy with the result. The code is shorter, 
easier to read, and the template system gives a much better view of 
whatt the output will look like. The RST migration will now be very easy 
to handle. Here's the patch: https://review.openstack.org/#/c/242936/

Do you think it's a good idea to migrate the other tools to jinja?

Thanks,
Gauvain



More information about the OpenStack-docs mailing list