From 32f4139a9d15074e50c234a6e0cefd113c5cd30c Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Wed, 29 Mar 2023 11:58:52 +0200
Subject: [PATCH] Vale ignores toctree and Sphinx ignores vale styles
---
docs/conf.py | 2 +-
docs/vale/.vale.ini | 6 ++++++
2 files changed, 7 insertions(+), 1 deletion(-)
diff --git a/docs/conf.py b/docs/conf.py
index 312a235..82a7b5d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -7,7 +7,7 @@ author = 'GÉANT Orchestration and Automation Team'
extensions = ['sphinx_rtd_theme', 'myst_parser']
templates_path = ['templates']
-exclude_patterns = ['build', 'Thumbs.db', '.DS_Store', 'venv']
+exclude_patterns = ['build', 'Thumbs.db', '.DS_Store', 'venv', 'vale']
source_suffix = {
'.md': 'markdown'
}
diff --git a/docs/vale/.vale.ini b/docs/vale/.vale.ini
index f2a63e2..adeeb6a 100644
--- a/docs/vale/.vale.ini
+++ b/docs/vale/.vale.ini
@@ -6,5 +6,11 @@ Vocab = geant-jargon, Sphinx
Packages = RedHat, proselint
+[formats]
+txt = md
+
[*]
BasedOnStyles = Vale, RedHat, proselint
+
+; Ignore the table of contents directive
+BlockIgnores = (?s) *(\x60\x60\x60{toctree}.*?\x60\x60\x60)
--
GitLab