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

Proposed by Ryan Harper
Status: Merged
Merged at revision: a07f2629f0a38b6277477b0002d39400d1ea1685
Proposed branch: ~raharper/cloud-init:fix-snap-user-doc
Merge into: cloud-init:master
Diff against target: 27 lines (+3/-2)
2 files modified
cloudinit/config/cc_snap_config.py (+2/-2)
doc/rtd/topics/modules.rst (+1/-0)
Reviewer Review Type Date Requested Status
Server Team CI bot continuous-integration Approve
cloud-init Commiters Pending
Review via email: mp+321229@code.launchpad.net

Description of the change

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.

To post a comment you must log in.
Revision history for this message
Server Team CI bot (server-team-bot) wrote :
review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/cloudinit/config/cc_snap_config.py b/cloudinit/config/cc_snap_config.py
2index db51166..fe0cc73 100644
3--- a/cloudinit/config/cc_snap_config.py
4+++ b/cloudinit/config/cc_snap_config.py
5@@ -5,8 +5,8 @@
6 # This file is part of cloud-init. See LICENSE file for license information.
7
8 """
9-Snappy
10-------
11+Snap Config
12+-----------
13 **Summary:** snap_config modules allows configuration of snapd.
14
15 This module uses the same ``snappy`` namespace for configuration but
16diff --git a/doc/rtd/topics/modules.rst b/doc/rtd/topics/modules.rst
17index a3ead4f..c963c09 100644
18--- a/doc/rtd/topics/modules.rst
19+++ b/doc/rtd/topics/modules.rst
20@@ -44,6 +44,7 @@ Modules
21 .. automodule:: cloudinit.config.cc_set_hostname
22 .. automodule:: cloudinit.config.cc_set_passwords
23 .. automodule:: cloudinit.config.cc_snappy
24+.. automodule:: cloudinit.config.cc_snap_config
25 .. automodule:: cloudinit.config.cc_spacewalk
26 .. automodule:: cloudinit.config.cc_ssh
27 .. automodule:: cloudinit.config.cc_ssh_authkey_fingerprints

Subscribers

People subscribed via source and target branches