The template I use with Spyder
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
summary
description
:REQUIRES:
:TODO:
:AUTHOR:
:ORGANIZATION:
:CONTACT:
:SINCE: %(date)s
:VERSION: 0.1
"""
#===============================================================================
# PROGRAM METADATA
#===============================================================================
__author__ = ''
__contact__ = ''
__copyright__ = ''
__license__ = ''
__date__ = '%(date)s'
__version__ = '0.1'
#===============================================================================
# IMPORT STATEMENTS
#===============================================================================
from numpy import * # IMPORTS ndarray(), arange(), zeros(), ones()
set_printoptions(precision=5)
set_printoptions(suppress=True)
#from visual import * # IMPORTS NumPy.*, SciPy.*, and Visual objects (sphere, box, etc.)
#import matplotlib.pyplot as plt # plt.plot(x,y) plt.show()
#from pylab import * # IMPORTS NumPy.*, SciPy.*, and matplotlib.*
#import os # os.walk(basedir) FOR GETTING DIR STRUCTURE
#import pickle # pickle.load(fromfile) pickle.dump(data, tofile)
#from tkFileDialog import askopenfilename, askopenfile
#from collections import namedtuple
#from ctypes import *
#import glob
#import random
#import cv2
#===============================================================================
# METHODS
#===============================================================================
#===============================================================================
# MAIN METHOD AND TESTING AREA
#===============================================================================
def main():
"""Description of main()"""
if __name__ == '__main__':
main()
#===============================================================================
# QUICK REFERENCE
#===============================================================================
'''Templates and markup notes
>>SPYDER Note markers
#XXX: !
#TODO: ?
#FIXME: ?
#HINT: !
#TIP: !
>>SPHINX markup
:Any words between colons: Description following.
Indent any continuation and it will be concatenated.
.. warning:: ...
.. note:: ...
.. todo:: ...
- List items with - or +
- List item 2
For a long hyphen use ---
Start colored formatted code with >>> and ...
**bold** and *italic* inline emphasis
>>SPHINX Method simple doc template (DIY formatting):
""" summary
description
- **param** --- desc
- *return* --- desc
"""
>>SPHINX Method longer template (with Sphinx keywords):
""" summary
description
:type name: type optional
:arg name: desc
:returns: desc
(optional intro to block)::
Skip line and indent monospace block
>>> python colored code example
... more code
"""
See http://scienceoss.com/use-sphinx-for-documentation/ for more details on
running Sphinx
'''