From fd45191f96e498e1caf8abb8c691a95100da9302 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Gmach?= Date: Thu, 13 Jul 2023 09:56:00 +0200 Subject: [PATCH 1/2] Exclude cheatsheets from sphinx build The cheatsheets were never intended to be included in the build and might cause build errors. Fixes #58. --- conf.py | 8 +++++++- doc-cheat-sheet-myst.md.txt => doc-cheat-sheet-myst.md | 0 doc-cheat-sheet.rst.txt => doc-cheat-sheet.rst | 0 3 files changed, 7 insertions(+), 1 deletion(-) rename doc-cheat-sheet-myst.md.txt => doc-cheat-sheet-myst.md (100%) rename doc-cheat-sheet.rst.txt => doc-cheat-sheet.rst (100%) diff --git a/conf.py b/conf.py index 8a26bf29..dbf85b95 100644 --- a/conf.py +++ b/conf.py @@ -46,7 +46,13 @@ ### General configuration ############################################################ -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.sphinx'] +exclude_patterns = [ + '_build', + 'Thumbs.db', + '.DS_Store', + '.sphinx', + 'doc-cheat-sheet*', +] exclude_patterns.extend(custom_excludes) rst_epilog = ''' diff --git a/doc-cheat-sheet-myst.md.txt b/doc-cheat-sheet-myst.md similarity index 100% rename from doc-cheat-sheet-myst.md.txt rename to doc-cheat-sheet-myst.md diff --git a/doc-cheat-sheet.rst.txt b/doc-cheat-sheet.rst similarity index 100% rename from doc-cheat-sheet.rst.txt rename to doc-cheat-sheet.rst From 9fdb69ddd167fb23ffda37a6facabd3c5b0cd155 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Gmach?= Date: Thu, 13 Jul 2023 10:29:38 +0200 Subject: [PATCH 2/2] Do not check the cheat sheets with woke ... as they contain a link to an external documentation which URL contains the word "master". --- .wokeignore | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 .wokeignore diff --git a/.wokeignore b/.wokeignore new file mode 100644 index 00000000..2e484ce9 --- /dev/null +++ b/.wokeignore @@ -0,0 +1,4 @@ +# the cheat sheets contain a link to a link with a block word which we cannot +# avoid for now, ie +# https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html +doc-cheat-sheet*