added example for seealso, todo, warning, note boxes to template
authorChristian Herdtweck <christian.herdtweck@intra2net.com>
Thu, 27 Aug 2015 09:04:33 +0000 (11:04 +0200)
committerChristian Herdtweck <christian.herdtweck@intra2net.com>
Thu, 27 Aug 2015 09:04:33 +0000 (11:04 +0200)
template.py

index 090bb82..f61c870 100644 (file)
@@ -24,8 +24,12 @@ Module name: Summary of this module
 Some overview over important classes and functions and such should be specified
 in this docstring, but please keep it brief!
 
-Do not forget to correct the codeauthor and license text commented by hashes
-above.
+
+.. seealso:: http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
+.. todo:: Do not forget to correct the codeauthor and license text commented by
+          hashes above.
+.. note:: You should note this
+.. warning:: This is a warning
 
 .. codeauthor:: John Doe, john.doe@intra2net.com
 """