fix(docs): display examples correctly in RTD (#5139)

Signed-off-by: Dariusz Duda <dariusz.duda@canonical.com>
canonical · Nov 7, 2024 · 2b2cb61 · 2b2cb61
1 parent 187187d
commit 2b2cb61
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/snapcraft/commands/legacy.py b/snapcraft/commands/legacy.py
@@ -62,7 +62,8 @@ class StoreLegacyUploadMetadataCommand(LegacyAppCommand):
         If --force is used, it will force the local metadata into the Store,
         ignoring any possible conflict.
 
-        Examples:
+        Examples::
+
             snapcraft upload-metadata my-snap_0.1_amd64.snap
             snapcraft upload-metadata my-snap_0.1_amd64.snap --force
         """

diff --git a/snapcraft/commands/manage.py b/snapcraft/commands/manage.py
@@ -56,7 +56,8 @@ class StoreReleaseCommand(AppCommand):
             - <branch> is optional and dynamically creates a channel with a
               specific expiration date.
 
-        Examples:
+        Examples::
+
             snapcraft release my-snap 8 stable
             snapcraft release my-snap 8 stable/my-branch
             snapcraft release my-snap 9 beta,edge
@@ -120,7 +121,8 @@ class StoreCloseCommand(AppCommand):
         As such, closing the 'candidate' channel for a snap would make
         that snap begin to track the 'stable' channel.
 
-        Examples:
+        Examples::
+
             snapcraft close my-snap --channel beta
         """
     )

diff --git a/snapcraft/commands/status.py b/snapcraft/commands/status.py
@@ -431,7 +431,8 @@ class StoreListRevisionsCommand(AppCommand):
     help_msg = "List published revisions for <snap-name>"
     overview = textwrap.dedent(
         """
-        Examples:
+        Examples::
+
             snapcraft list-revisions my-snap
             snapcraft list-revisions my-snap --arch armhf
             snapcraft revisions my-snap