ctools

#!/usr/bin/python

# Nathan Kelley-Hoskins

# 2015Jun30

import sys, re

if len(sys.argv) != 3 :

  print """

Clean up input_filename RST file for easier human readability, and write to output_filename.'

usage: $ %s input_filename output_filename' % sys.argv[0]

"""

  sys.exit(1)

inputfile  = sys.argv[1]

outputfile = sys.argv[2]

with open( outputfile, 'w') as fout :

  with open( inputfile, 'rU') as fin : # the 'U' is for reading newlines (\n) or carriage returns (\r or ^M)

    for line in fin :

      repline = line

      # don't write line to output if its not needed

      if re.search('^.. _', repline ) : continue

      if re.search('\:ref\:`', repline ) : 

        # get rid of reference notation

        repline = repline.replace( ':ref:', '' ) 

        repline = repline.replace( '`'    , '' )

      repline = repline.replace( '``'       , ''             ) # remove ``

      repline = repline.replace( '.. note::', 'Note\n----\n' ) # replace note tag with cleaner Note title

      fout.write( repline )