spacepy.rst

Created on Mon Sep 10 13:09:11 2012

@author: balarsen

Functions

listToEnumerate(inList[, startingNum, makeBlock])

starting from a python list return a string that is the RST equlivant of the list in enumerated list makeBlock : make the text into a text block in rst if there are newline chars in the string

listToList(inList[, makeBlock])

starting from a python list return a string that is the RST equlivant of the list in a bulleted list

listToTable(data[, header, title])

starting from a python list return a string that is the RST equlivant of the list in rst table format

strToHeading(string[, level])

return a rst heading from the given string (soplit on spaces) document title: === aboce and below (-2) document subtitle: --- above and below (-1) section 1: ==== (0) subsection 1.1: ---- (1) subsubsection 1.1.1: ~~~~ (2)

spacepy.rst.listToEnumerate(inList, startingNum=1, makeBlock=True)[source]

starting from a python list return a string that is the RST equlivant of the list in enumerated list makeBlock : make the text into a text block in rst if there are newline chars in the string

spacepy.rst.listToList(inList, makeBlock=True)[source]

starting from a python list return a string that is the RST equlivant of the list in a bulleted list

spacepy.rst.listToTable(data, header='', title='')[source]

starting from a python list return a string that is the RST equlivant of the list in rst table format

based loosly on http://stackoverflow.com/questions/11347505/what-are-some-approaches-to-outputting-a-python-data-structure-to-restructuredte see http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html#tables

spacepy.rst.strToHeading(string, level=0)[source]

return a rst heading from the given string (soplit on spaces) document title: === aboce and below (-2) document subtitle: — above and below (-1) section 1: ==== (0) subsection 1.1: —- (1) subsubsection 1.1.1: ~~~~ (2)