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_final_message.py | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) (limited to 'cloudinit/config/cc_final_message.py') diff --git a/cloudinit/config/cc_final_message.py b/cloudinit/config/cc_final_message.py index c9021eb1..5e144fde 100644 --- a/cloudinit/config/cc_final_message.py +++ b/cloudinit/config/cc_final_message.py @@ -18,6 +18,31 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Final Message +------------- +**Summary:** output final message when cloud-init has finished + +This module configures the final message that cloud-init writes. The message is +specified as a jinja template with the following variables set: + + - ``version``: cloud-init version + - ``timestamp``: time at cloud-init finish + - ``datasource``: cloud-init data source + - ``uptime``: system uptime + +**Internal name:** ``cc_final_message`` + +**Module frequency:** per always + +**Supported distros:** all + +**Config keys**:: + + final_message: + +""" + from cloudinit import templater from cloudinit import util from cloudinit import version -- cgit v1.2.3