From 1071b9940b4e114cd2eabf290b739f92fbab33de Mon Sep 17 00:00:00 2001 From: Wesley Wiedenmeier Date: Sun, 28 Aug 2016 17:56:17 -0500 Subject: Improve module documentation and doc cleanup. This adds lots of config module documentation in a standard format. It will greatly improve the content at readthedocs. Additionally: * Add a 'doc' env to tox.ini * Changed default highlight language for sphinx conf from python to yaml most examples in documentation are yaml configs * Updated datasource examples to highlight sh code properly --- cloudinit/config/cc_foo.py | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'cloudinit/config/cc_foo.py') diff --git a/cloudinit/config/cc_foo.py b/cloudinit/config/cc_foo.py index 95aab4dd..ad0e0468 100644 --- a/cloudinit/config/cc_foo.py +++ b/cloudinit/config/cc_foo.py @@ -18,6 +18,20 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Foo +--- +**Summary:** example module + +Example to show module structure. Does not do anything. + +**Internal name:** ``cc_foo`` + +**Module frequency:** per instance + +**Supported distros:** all +""" + from cloudinit.settings import PER_INSTANCE # Modules are expected to have the following attributes. @@ -35,7 +49,7 @@ from cloudinit.settings import PER_INSTANCE # Typically those are from module configuration where the module # is defined with some extra configuration that will eventually # be translated from yaml into arguments to this module. -# 2. A optional 'frequency' that defines how often this module should be ran. +# 2. A optional 'frequency' that defines how often this module should be run. # Typically one of PER_INSTANCE, PER_ALWAYS, PER_ONCE. If not # provided PER_INSTANCE will be assumed. # See settings.py for these constants. -- cgit v1.2.3