diff --git a/docs/.gitlab-ci.yml b/docs/.gitlab-ci.yml index 21c42d75bdb19bb8260534de3b3e34fa5fc8fd45..e1c5b30c8260e431ec05538dbe78631b9e08db82 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 11baf7ab5900c01c35ce6435b80929eb00fb3927..773660dcd4827250dbbc8a39168ab433eac459fa 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 3abe670e22315ca4b13a17c3702bf9d2fc9b4d84..28644a97d552aca79601800ede03d1c5decf3f46 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 2fbf4392d90d70bc90362d865f0888f13085535f..08664fd56d49a17891d701b7f1e20297bac634b0 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 1d13a809d0a79120dcb7d1f4554a0cb7eedcb933..e8cbd9ee75595620ad45edd4c707e60da12dc48a 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