From 63db8561c554dcfa66f976f7ec867fd063ace205 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= <hugo@lysator.liu.se>
Date: Sat, 26 Aug 2023 12:35:52 +0200
Subject: [PATCH] Fix some documentation warnings.
---
muppet/puppet/ast.py | 4 ++--
muppet/puppet/format/text.py | 6 +++++-
2 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/muppet/puppet/ast.py b/muppet/puppet/ast.py
index 63127b9..af2ccb1 100644
--- a/muppet/puppet/ast.py
+++ b/muppet/puppet/ast.py
@@ -231,7 +231,7 @@ class PuppetExportedQuery(Puppet):
"""
An exported query.
- .. highlight:: puppet
+ .. code-block:: puppet
<<| filter |>>
"""
@@ -244,7 +244,7 @@ class PuppetVirtualQuery(Puppet):
"""
A virtual query.
- .. highlight:: puppet
+ .. code-block:: puppet
<| q |>
"""
diff --git a/muppet/puppet/format/text.py b/muppet/puppet/format/text.py
index 9d89042..2ac3aaa 100644
--- a/muppet/puppet/format/text.py
+++ b/muppet/puppet/format/text.py
@@ -62,7 +62,11 @@ def find_heredoc_delimiter(
Heredoc's are delimited like
- .. code-block:: puppet
+ .. Syntax highlighting disabled since the puppet highlighter
+ fails on the '@' sign, causing a warning in the build log (and
+ highlighting the '@' as an error in the output)
+
+ .. code-block::
@(EOF)
Some text
--
GitLab