From 1d8e768757be5237b318d72a6d64dbe2692214dc Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Mon, 31 Jul 2017 13:29:02 -0400 Subject: [PATCH] address comments in contributor docs This patch addresses the comments left on I9f98c78bc4b13ea64b6cb96537e81b69267905b1 when it was approved. Change-Id: Ica64f8f1537dbcfbc943b9f478820ac9785279f0 Signed-off-by: Doug Hellmann --- .../source/doc-tools/template-generator.rst | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/contributor-guide/source/doc-tools/template-generator.rst b/doc/contributor-guide/source/doc-tools/template-generator.rst index a75dde1f96..7b0396d998 100644 --- a/doc/contributor-guide/source/doc-tools/template-generator.rst +++ b/doc/contributor-guide/source/doc-tools/template-generator.rst @@ -1,13 +1,13 @@ .. _template-generator: -============================ - Template generator details -============================ +========================== +Template generator details +========================== -The content on docs.openstack.org that is not managed as document sets -built by Sphinx is handled via a custom template rendering tool in -``tools/www-generator.py`` within the openstack-manuals git -repository. +The portion of the content on docs.openstack.org that is not managed +as document sets built by Sphinx is handled via a custom template +rendering tool in ``tools/www-generator.py`` within the +openstack-manuals git repository. The script reads YAML data files in ``www/project-data`` to determine which projects exist in a given series and how they should be @@ -29,7 +29,7 @@ templates to complete HTML pages, which it writes to the .. _Jinja2: http://jinja.pocoo.org Defining release series -======================= +~~~~~~~~~~~~~~~~~~~~~~~ The set of release series and their individual status and other metadata is embedded in the template generator script in the @@ -65,7 +65,7 @@ For each release series, the generator needs to know: cycle. Project data file format -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ The projects associated with each release series are listed in a separate YAML file in the ``www/project-data`` directory. Each file is @@ -148,7 +148,7 @@ include a link to that documentation on the templated landing pages. flags are set. Template variables -================== +~~~~~~~~~~~~~~~~~~ The template generator uses the input data to set several variables visible within the template. This allows us to reuse the same template