From 27e52aaa1b91168753f9cf1f2a87fd958a6bb97f Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Wed, 5 Jul 2023 12:16:45 +0200
Subject: [PATCH] update Vale pipeline
---
docs/.gitlab-ci.yml | 2 +-
docs/build_docs.sh | 2 +-
docs/vale/.vale.ini | 29 ++++++++++++++++---
docs/vale/styles/Vocab/Sphinx/accept.txt | 1 +
.../vale/styles/Vocab/geant-jargon/accept.txt | 5 ++++
5 files changed, 33 insertions(+), 6 deletions(-)
diff --git a/docs/.gitlab-ci.yml b/docs/.gitlab-ci.yml
index 21c42d75..e1c5b30c 100644
--- a/docs/.gitlab-ci.yml
+++ b/docs/.gitlab-ci.yml
@@ -34,4 +34,4 @@ lint-documentation:
- vale sync
script:
- - vale $CI_PROJECT_DIR/docs/build/html/_sources
+ - vale --glob='!$CI_PROJECT_DIR/docs/build/html/apidocs/gso/gso.services._ipam.html' --config="$CI_PROJECT_DIR/docs/vale/.vale.ini" $CI_PROJECT_DIR/docs/source/index.md $CI_PROJECT_DIR/docs/source/glossary.md $CI_PROJECT_DIR/docs/source/quickstart.md $CI_PROJECT_DIR/docs/build/html/apidocs
diff --git a/docs/build_docs.sh b/docs/build_docs.sh
index 11baf7ab..773660dc 100755
--- a/docs/build_docs.sh
+++ b/docs/build_docs.sh
@@ -7,4 +7,4 @@ if [ ! -d ./vale/styles/proselint ] || [ ! -d ./vale/styles/Microsoft ]; then
docker run -it --rm -v $(pwd):/docs jdkato/vale:latest --config="/docs/vale/.vale.ini" sync
fi
-docker run -it --rm -v $(pwd):/docs jdkato/vale:latest --config="/docs/vale/.vale.ini" /docs/build/html/_sources/
+docker run -it --rm -v $(pwd):/docs jdkato/vale:latest --glob='!/docs/build/html/apidocs/gso/gso.services._ipam.html' --config="/docs/vale/.vale.ini" /docs/source/index.md /docs/source/glossary.md /docs/source/quickstart.md /docs/build/html/apidocs
diff --git a/docs/vale/.vale.ini b/docs/vale/.vale.ini
index 3abe670e..28644a97 100644
--- a/docs/vale/.vale.ini
+++ b/docs/vale/.vale.ini
@@ -6,11 +6,32 @@ Vocab = geant-jargon, Sphinx
Packages = proselint, Microsoft
-[formats]
-txt = md
-
[*]
BasedOnStyles = Vale, proselint, Microsoft
+; Disable style rules for headings, as these conflict with what is generated by autodoc
+; Microsoft.Headings = NO
+; Microsoft.HeadingAcronyms = NO
+; Microsoft.Dashes = NO
+
+; Ignore acronyms if they are tagged as a term
+; TokenIgnores = ([^\n]+std-term[^\n]+)
+; TokenIgnores = ('<span class="xref std std-term">GSO<\/span>')
+; TokenIgnores = ({term}`[^\n]+`)
+
; Ignore the table of contents directive
-BlockIgnores = (?s) *(\x60\x60\x60{toctree}.*?\x60\x60\x60)
+; BlockIgnores = (?s) *(\x60\x60\x60{toctree}.*?\x60\x60\x60)
+; BlockIgnores = (?s) *(# {py:mod}\x60[^\n]+\x60)
+
+; Ignore <link>-style links
+
+; TokenIgnores = (<http[^\n]+>+?)
+
+[*.html]
+Microsoft.Dashes = NO
+Microsoft.Headings = NO
+Microsoft.HeadingAcronyms = NO
+
+[/docs/source/glossary.md]
+; Ignore acronyms being undefined in the file that defines all acronyms by definition
+Microsoft.Acronyms = NO
diff --git a/docs/vale/styles/Vocab/Sphinx/accept.txt b/docs/vale/styles/Vocab/Sphinx/accept.txt
index 2fbf4392..08664fd5 100644
--- a/docs/vale/styles/Vocab/Sphinx/accept.txt
+++ b/docs/vale/styles/Vocab/Sphinx/accept.txt
@@ -1,3 +1,4 @@
toctree
[Ss]ubpackages
virtualenv
+Previous
diff --git a/docs/vale/styles/Vocab/geant-jargon/accept.txt b/docs/vale/styles/Vocab/geant-jargon/accept.txt
index 1d13a809..e8cbd9ee 100644
--- a/docs/vale/styles/Vocab/geant-jargon/accept.txt
+++ b/docs/vale/styles/Vocab/geant-jargon/accept.txt
@@ -1 +1,6 @@
GÉANT Automation Platform
+Vereniging
+TERMINATE
+WFO
+Ansible
+[Dd]eprovision
--
GitLab