← Back to team overview

cloud-init-dev team mailing list archive

[Merge] ~raharper/cloud-init:fix-snap-user-doc into cloud-init:master


Ryan Harper has proposed merging ~raharper/cloud-init:fix-snap-user-doc into cloud-init:master.

Requested reviews:
  cloud init development team (cloud-init-dev)

For more details, see:

Add rtd entry for snap_config config module

Fix missing snap_config module documentation by adding it to
the modules list.  Update the documentation title so it does
not collide with existing snappy title.
Your team cloud init development team is requested to review the proposed merge of ~raharper/cloud-init:fix-snap-user-doc into cloud-init:master.
diff --git a/cloudinit/config/cc_snap_config.py b/cloudinit/config/cc_snap_config.py
index db51166..fe0cc73 100644
--- a/cloudinit/config/cc_snap_config.py
+++ b/cloudinit/config/cc_snap_config.py
@@ -5,8 +5,8 @@
 # This file is part of cloud-init. See LICENSE file for license information.
+Snap Config
 **Summary:** snap_config modules allows configuration of snapd.
 This module uses the same ``snappy`` namespace for configuration but
diff --git a/doc/rtd/topics/modules.rst b/doc/rtd/topics/modules.rst
index a3ead4f..c963c09 100644
--- a/doc/rtd/topics/modules.rst
+++ b/doc/rtd/topics/modules.rst
@@ -44,6 +44,7 @@ Modules
 .. automodule:: cloudinit.config.cc_set_hostname
 .. automodule:: cloudinit.config.cc_set_passwords
 .. automodule:: cloudinit.config.cc_snappy
+.. automodule:: cloudinit.config.cc_snap_config
 .. automodule:: cloudinit.config.cc_spacewalk
 .. automodule:: cloudinit.config.cc_ssh
 .. automodule:: cloudinit.config.cc_ssh_authkey_fingerprints

Follow ups