openinfra/interop
Code Issues Proposed changes

Fixing generator to output doc8 compliant rst

Browse Source 
Re-generated rst files
* 2015.03.rst
* 2015.04.rst
* 2015.05.rst

Change-Id: I15b169cf92c7b1fc1c93e0dbbb1b03be2e21f407
This commit is contained in:
Justin Shepherd 2015-06-08 10:20:47 -05:00
parent ad47d29591
commit 7402f39f9a
4 changed files with 86 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
2015.03.rst
View File

@ -30,7 +30,7 @@ Platform Components
Compute Component Capabilities Compute Component Capabilities
============================== ==============================
Required Capabilities Required Capabilities
----------------------- -----------------------
* Compute-auth (nova) * Compute-auth (nova)
* Compute-flavors (nova) * Compute-flavors (nova)
@ -42,16 +42,16 @@ Required Capabilities
* Compute-volume (nova) * Compute-volume (nova)
* Images-v2 (glance) * Images-v2 (glance)
Advisory Capabilities Advisory Capabilities
----------------------- -----------------------
* Auth-token (keystone) * Auth-token (keystone)
* Compute-servers-metadata (nova) * Compute-servers-metadata (nova)
Deprecated Capabilities Deprecated Capabilities
------------------------- -------------------------
None None
Removed Capabilities Removed Capabilities
---------------------- ----------------------
* Compute floating ips (None) * Compute floating ips (None)
* Images-v1 (None) * Images-v1 (None)
@ -62,21 +62,21 @@ Removed Capabilities
Object Component Capabilities Object Component Capabilities
============================= =============================
Required Capabilities Required Capabilities
----------------------- -----------------------
* Objectstore-object (swift) * Objectstore-object (swift)
Advisory Capabilities Advisory Capabilities
----------------------- -----------------------
None None
Deprecated Capabilities Deprecated Capabilities
------------------------- -------------------------
None None
Removed Capabilities Removed Capabilities
---------------------- ----------------------
None None
Designated Sections Designated Sections
@ -87,19 +87,26 @@ this specification.
Required Designated Sections Required Designated Sections
---------------------------- ----------------------------
* Cinder : Designated sections are the API implementation code * Cinder : Designated sections are the API implementation code
* Glance : Designated sections are the API implementation code and domain model. * Glance : Designated sections are the API implementation code and domain
* Nova : By default, designated except scheduler, filter, drivers, API extensions and networking. model.
* Swift : Designated sections are proxy server, object server, container server, account server and select middleware * 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 Advisory Designated Sections
---------------------------- ----------------------------
* Keystone : Update pending from PTL * Keystone : Update pending from PTL
Deprecated Designated Sections Deprecated Designated Sections
------------------------------ ------------------------------
None None
Removed Designated Sections Removed Designated Sections
--------------------------- ---------------------------
None None

39
2015.04.rst
View File

@ -30,7 +30,7 @@ Platform Components
Compute Component Capabilities Compute Component Capabilities
============================== ==============================
Required Capabilities Required Capabilities
----------------------- -----------------------
* Compute-auth (nova) * Compute-auth (nova)
* Compute-flavors (nova) * Compute-flavors (nova)
@ -42,39 +42,39 @@ Required Capabilities
* Compute-volume (nova) * Compute-volume (nova)
* Images-v2 (glance) * Images-v2 (glance)
Advisory Capabilities Advisory Capabilities
----------------------- -----------------------
* Auth-token (keystone) * Auth-token (keystone)
* Compute-servers-metadata (nova) * Compute-servers-metadata (nova)
Deprecated Capabilities Deprecated Capabilities
------------------------- -------------------------
None None
Removed Capabilities Removed Capabilities
---------------------- ----------------------
None None
Object Component Capabilities Object Component Capabilities
============================= =============================
Required Capabilities Required Capabilities
----------------------- -----------------------
* Objectstore-object (swift) * Objectstore-object (swift)
Advisory Capabilities Advisory Capabilities
----------------------- -----------------------
None None
Deprecated Capabilities Deprecated Capabilities
------------------------- -------------------------
None None
Removed Capabilities Removed Capabilities
---------------------- ----------------------
None None
Designated Sections Designated Sections
@ -85,19 +85,26 @@ this specification.
Required Designated Sections Required Designated Sections
---------------------------- ----------------------------
* Cinder : Designated sections are the API implementation code * Cinder : Designated sections are the API implementation code
* Glance : Designated sections are the API implementation code and domain model. * Glance : Designated sections are the API implementation code and domain
* Nova : By default, designated except scheduler, filter, drivers, API extensions and networking. model.
* Swift : Designated sections are proxy server, object server, container server, account server and select middleware * 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 Advisory Designated Sections
---------------------------- ----------------------------
* Keystone : Update pending from PTL * Keystone : Update pending from PTL
Deprecated Designated Sections Deprecated Designated Sections
------------------------------ ------------------------------
None None
Removed Designated Sections Removed Designated Sections
--------------------------- ---------------------------
None None

42
2015.05.rst
View File

@ -30,7 +30,7 @@ Platform Components
Compute Component Capabilities Compute Component Capabilities
============================== ==============================
Required Capabilities Required Capabilities
----------------------- -----------------------
* Identity-auth (keystone) * Identity-auth (keystone)
* Compute-auth (nova) * Compute-auth (nova)
@ -43,40 +43,40 @@ Required Capabilities
* Compute-volume (nova) * Compute-volume (nova)
* Images-v2 (nova) * Images-v2 (nova)
Advisory Capabilities Advisory Capabilities
----------------------- -----------------------
* Auth-token (keystone) * Auth-token (keystone)
* Compute-servers-metadata (nova) * Compute-servers-metadata (nova)
Deprecated Capabilities Deprecated Capabilities
------------------------- -------------------------
None None
Removed Capabilities Removed Capabilities
---------------------- ----------------------
None None
Object Component Capabilities Object Component Capabilities
============================= =============================
Required Capabilities Required Capabilities
----------------------- -----------------------
* Objectstore-object (swift) * Objectstore-object (swift)
Advisory Capabilities Advisory Capabilities
----------------------- -----------------------
* Identity-auth (keystone) * Identity-auth (keystone)
* Auth-token (keystone) * Auth-token (keystone)
Deprecated Capabilities Deprecated Capabilities
------------------------- -------------------------
None None
Removed Capabilities Removed Capabilities
---------------------- ----------------------
None None
Designated Sections Designated Sections
@ -87,20 +87,30 @@ this specification.
Required Designated Sections Required Designated Sections
---------------------------- ----------------------------
* Cinder : Designated sections are the API implementation code * Cinder : Designated sections are the API implementation code
* Glance : Designated sections are the API implementation code and domain model. * Glance : Designated sections are the API implementation code and domain
* 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. model.
* Nova : By default, designated except scheduler, filter, drivers, API extensions and networking. * Keystone : Designation is outlined per API grouping. Identity (user and
* Swift : Designated sections are proxy server, object server, container server, account server and select middleware 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 Advisory Designated Sections
---------------------------- ----------------------------
None None
Deprecated Designated Sections Deprecated Designated Sections
------------------------------ ------------------------------
None None
Removed Designated Sections Removed Designated Sections
--------------------------- ---------------------------
None None

22
tools/jsonToRst.py
View File

@ -19,6 +19,7 @@
import json import json
import sys import sys
import textwrap
def printHelpArrays(input): def printHelpArrays(input):
@ -30,6 +31,8 @@ def printHelpArrays(input):
return output[0:-2] return output[0:-2]
wrapper = textwrap.TextWrapper(width=79, subsequent_indent=' ')
inFileName = "NONE" inFileName = "NONE"
for potentialFile in sys.argv: for potentialFile in sys.argv:
if ".json" in potentialFile: if ".json" in potentialFile:
@ -127,12 +130,12 @@ Platform Components
for event in order: for event in order:
outFile.write("\n{event} Capabilities \n".format( outFile.write("\n{event} Capabilities\n".format(
event=event.capitalize())) event=event.capitalize()))
outFile.write("-" * (len(event) + 15) + "\n") outFile.write("-" * (len(event) + 15) + "\n")
if(len(data['components'][component][event]) == 0): if(len(data['components'][component][event]) == 0):
outFile.write("None \n") outFile.write("None\n")
for req in data['components'][component][event]: for req in data['components'][component][event]:
if not data["capabilities"][req].get('name') is None: if not data["capabilities"][req].get('name') is None:
@ -166,15 +169,20 @@ this specification.""")
outFile.write('\n\n{event} Designated Sections\n'.format( outFile.write('\n\n{event} Designated Sections\n'.format(
event=event.capitalize())) 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()) names = sorted(desig[event].keys())
if len(names) is 0: if len(names) is 0:
outFile.write('\nNone') outFile.write('None')
outlines = []
for name in names: for name in names:
outFile.write("\n* {name} : {guide}".format( outlines.append(
name=name.capitalize(), wrapper.fill(
guide=desig[event][name].get('guidance'))) "* {name} : {guide}".format(
name=name.capitalize(),
guide=desig[event][name].get('guidance'))))
outFile.write("\n".join(outlines))
outFile.write('\n') outFile.write('\n')