doc: exclude manpages from automatic doc checks

Signed-off-by: Ruth Fuchss <[email protected]>
canonical · Aug 22, 2023 · e508998 · e508998
1 parent 3b28a85
commit e508998
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/doc/.sphinx/.markdownlint/doc-lint.sh b/doc/.sphinx/.markdownlint/doc-lint.sh
@@ -14,6 +14,8 @@ for fn in $(find doc/ -name '*.md'); do
     sed -E "s/(\(.+\)=)/\1\n/" $fn > .tmp/$fn;
 done
 
+rm -rf .tmp/doc/reference/manpages/
+
 mdl .tmp/doc -sdoc/.sphinx/.markdownlint/style.rb -udoc/.sphinx/.markdownlint/rules.rb --ignore-front-matter > .tmp/errors.txt || true
 
 ## Postprocessing

diff --git a/doc/.sphinx/.spellcheck.yaml b/doc/.sphinx/.spellcheck.yaml
@@ -8,7 +8,7 @@ matrix:
     - doc/.sphinx/.wordlist.txt
     output: doc/.sphinx/.wordlist.dic
   sources:
-  - doc/html/**/*.html|!doc/html/config-options/index.html
+  - doc/html/**/*.html|!doc/html/config-options/index.html|!doc/html/reference/manpages/**/*.html
   pipeline:
   - pyspelling.filters.html:
       comments: false
@@ -24,3 +24,4 @@ matrix:
       - div.relatedlinks
       - span.guilabel
       - a.p-navigation__link
+      - div.visually-hidden
diff --git a/doc/conf.py b/doc/conf.py
@@ -239,6 +239,9 @@
     'https://127.0.0.1:8443/1.0',
     'https://web.libera.chat/#lxd'
 ]
+linkcheck_exclude_documents = [r'.*/manpages/.*']
+
+
 
 # Setup redirects (https://documatt.gitlab.io/sphinx-reredirects/usage.html)
 redirects = {