From 347e0287509b957b71ff89f02698dc5c5094211a Mon Sep 17 00:00:00 2001 From: Christian Herdtweck Date: Thu, 27 Aug 2015 11:04:33 +0200 Subject: [PATCH] added example for seealso, todo, warning, note boxes to template --- template.py | 8 ++++++-- 1 files changed, 6 insertions(+), 2 deletions(-) diff --git a/template.py b/template.py index 090bb82..f61c870 100644 --- a/template.py +++ b/template.py @@ -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 """ -- 1.7.1