From 7402f39f9abfa46af93572915f8a8b430584fd34 Mon Sep 17 00:00:00 2001 From: Justin Shepherd Date: Mon, 8 Jun 2015 10:20:47 -0500 Subject: [PATCH] Fixing generator to output doc8 compliant rst Re-generated rst files * 2015.03.rst * 2015.04.rst * 2015.05.rst Change-Id: I15b169cf92c7b1fc1c93e0dbbb1b03be2e21f407 --- 2015.03.rst | 37 ++++++++++++++++++++++--------------- 2015.04.rst | 39 +++++++++++++++++++++++---------------- 2015.05.rst | 42 ++++++++++++++++++++++++++---------------- tools/jsonToRst.py | 22 +++++++++++++++------- 4 files changed, 86 insertions(+), 54 deletions(-) diff --git a/2015.03.rst b/2015.03.rst index 77754197..d9398a7f 100644 --- a/2015.03.rst +++ b/2015.03.rst @@ -30,7 +30,7 @@ Platform Components Compute Component Capabilities ============================== -Required Capabilities +Required Capabilities ----------------------- * Compute-auth (nova) * Compute-flavors (nova) @@ -42,16 +42,16 @@ Required Capabilities * Compute-volume (nova) * Images-v2 (glance) -Advisory Capabilities +Advisory Capabilities ----------------------- * Auth-token (keystone) * Compute-servers-metadata (nova) -Deprecated Capabilities +Deprecated Capabilities ------------------------- -None +None -Removed Capabilities +Removed Capabilities ---------------------- * Compute floating ips (None) * Images-v1 (None) @@ -62,21 +62,21 @@ Removed Capabilities Object Component Capabilities ============================= -Required Capabilities +Required Capabilities ----------------------- * Objectstore-object (swift) -Advisory Capabilities +Advisory Capabilities ----------------------- -None +None -Deprecated Capabilities +Deprecated Capabilities ------------------------- -None +None -Removed Capabilities +Removed Capabilities ---------------------- -None +None Designated Sections @@ -87,19 +87,26 @@ this specification. Required Designated Sections ---------------------------- + * Cinder : Designated sections are the API implementation code -* Glance : Designated sections are the API implementation code and domain model. -* Nova : By default, designated except scheduler, filter, drivers, API extensions and networking. -* Swift : Designated sections are proxy server, object server, container server, account server and select middleware +* Glance : Designated sections are the API implementation code and domain + model. +* Nova : By default, designated except scheduler, filter, drivers, API + extensions and networking. +* Swift : Designated sections are proxy server, object server, container + server, account server and select middleware Advisory Designated Sections ---------------------------- + * Keystone : Update pending from PTL Deprecated Designated Sections ------------------------------ + None Removed Designated Sections --------------------------- + None diff --git a/2015.04.rst b/2015.04.rst index 45951434..46c791fa 100644 --- a/2015.04.rst +++ b/2015.04.rst @@ -30,7 +30,7 @@ Platform Components Compute Component Capabilities ============================== -Required Capabilities +Required Capabilities ----------------------- * Compute-auth (nova) * Compute-flavors (nova) @@ -42,39 +42,39 @@ Required Capabilities * Compute-volume (nova) * Images-v2 (glance) -Advisory Capabilities +Advisory Capabilities ----------------------- * Auth-token (keystone) * Compute-servers-metadata (nova) -Deprecated Capabilities +Deprecated Capabilities ------------------------- -None +None -Removed Capabilities +Removed Capabilities ---------------------- -None +None Object Component Capabilities ============================= -Required Capabilities +Required Capabilities ----------------------- * Objectstore-object (swift) -Advisory Capabilities +Advisory Capabilities ----------------------- -None +None -Deprecated Capabilities +Deprecated Capabilities ------------------------- -None +None -Removed Capabilities +Removed Capabilities ---------------------- -None +None Designated Sections @@ -85,19 +85,26 @@ this specification. Required Designated Sections ---------------------------- + * Cinder : Designated sections are the API implementation code -* Glance : Designated sections are the API implementation code and domain model. -* Nova : By default, designated except scheduler, filter, drivers, API extensions and networking. -* Swift : Designated sections are proxy server, object server, container server, account server and select middleware +* Glance : Designated sections are the API implementation code and domain + model. +* Nova : By default, designated except scheduler, filter, drivers, API + extensions and networking. +* Swift : Designated sections are proxy server, object server, container + server, account server and select middleware Advisory Designated Sections ---------------------------- + * Keystone : Update pending from PTL Deprecated Designated Sections ------------------------------ + None Removed Designated Sections --------------------------- + None diff --git a/2015.05.rst b/2015.05.rst index 1b1e6047..e97903d8 100644 --- a/2015.05.rst +++ b/2015.05.rst @@ -30,7 +30,7 @@ Platform Components Compute Component Capabilities ============================== -Required Capabilities +Required Capabilities ----------------------- * Identity-auth (keystone) * Compute-auth (nova) @@ -43,40 +43,40 @@ Required Capabilities * Compute-volume (nova) * Images-v2 (nova) -Advisory Capabilities +Advisory Capabilities ----------------------- * Auth-token (keystone) * Compute-servers-metadata (nova) -Deprecated Capabilities +Deprecated Capabilities ------------------------- -None +None -Removed Capabilities +Removed Capabilities ---------------------- -None +None Object Component Capabilities ============================= -Required Capabilities +Required Capabilities ----------------------- * Objectstore-object (swift) -Advisory Capabilities +Advisory Capabilities ----------------------- * Identity-auth (keystone) * Auth-token (keystone) -Deprecated Capabilities +Deprecated Capabilities ------------------------- -None +None -Removed Capabilities +Removed Capabilities ---------------------- -None +None Designated Sections @@ -87,20 +87,30 @@ this specification. Required Designated Sections ---------------------------- + * Cinder : Designated sections are the API implementation code -* Glance : Designated sections are the API implementation code and domain model. -* Keystone : Designation is outlined per API grouping. Identity (user and group) management APIs will not be designated. API access (with exception of auth) may be prohibited by policy (resulting in HTTP 403). Designated APIs include both v2.0 and v3 versions where applicable. -* Nova : By default, designated except scheduler, filter, drivers, API extensions and networking. -* Swift : Designated sections are proxy server, object server, container server, account server and select middleware +* Glance : Designated sections are the API implementation code and domain + model. +* Keystone : Designation is outlined per API grouping. Identity (user and + group) management APIs will not be designated. API access (with exception of + auth) may be prohibited by policy (resulting in HTTP 403). Designated APIs + include both v2.0 and v3 versions where applicable. +* Nova : By default, designated except scheduler, filter, drivers, API + extensions and networking. +* Swift : Designated sections are proxy server, object server, container + server, account server and select middleware Advisory Designated Sections ---------------------------- + None Deprecated Designated Sections ------------------------------ + None Removed Designated Sections --------------------------- + None diff --git a/tools/jsonToRst.py b/tools/jsonToRst.py index edad0998..faf8b54a 100755 --- a/tools/jsonToRst.py +++ b/tools/jsonToRst.py @@ -19,6 +19,7 @@ import json import sys +import textwrap def printHelpArrays(input): @@ -30,6 +31,8 @@ def printHelpArrays(input): return output[0:-2] +wrapper = textwrap.TextWrapper(width=79, subsequent_indent=' ') + inFileName = "NONE" for potentialFile in sys.argv: if ".json" in potentialFile: @@ -127,12 +130,12 @@ Platform Components for event in order: - outFile.write("\n{event} Capabilities \n".format( + outFile.write("\n{event} Capabilities\n".format( event=event.capitalize())) outFile.write("-" * (len(event) + 15) + "\n") if(len(data['components'][component][event]) == 0): - outFile.write("None \n") + outFile.write("None\n") for req in data['components'][component][event]: if not data["capabilities"][req].get('name') is None: @@ -166,15 +169,20 @@ this specification.""") outFile.write('\n\n{event} Designated Sections\n'.format( event=event.capitalize())) - outFile.write('-'*(len(event) + 20)) # +20 is for length of header + # +20 is for length of header + outFile.write('-'*(len(event) + 20) + '\n\n') names = sorted(desig[event].keys()) if len(names) is 0: - outFile.write('\nNone') + outFile.write('None') + outlines = [] for name in names: - outFile.write("\n* {name} : {guide}".format( - name=name.capitalize(), - guide=desig[event][name].get('guidance'))) + outlines.append( + wrapper.fill( + "* {name} : {guide}".format( + name=name.capitalize(), + guide=desig[event][name].get('guidance')))) + outFile.write("\n".join(outlines)) outFile.write('\n')