update Vale pipeline

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

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

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

docs/vale/styles/Vocab/Sphinx/accept.txt

 toctree
 [Ss]ubpackages
 virtualenv
+Previous

docs/vale/styles/Vocab/geant-jargon/accept.txt

 GÉANT Automation Platform
+Vereniging
+TERMINATE
+WFO
+Ansible
+[Dd]eprovision