Merge pull request #59 from jugmac00/exclude-cheatsheets-from-building

Exclude cheatsheets from sphinx build
canonical · Jul 17, 2023 · 9be6f85 · 9be6f85
2 parents 5afe29d + 9fdb69d
commit 9be6f85
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 1 deletion.
diff --git a/.wokeignore 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*
diff --git 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 → doc-cheat-sheet-myst.md b/doc-cheat-sheet-myst.md.txt → doc-cheat-sheet-myst.md
diff --git a/doc-cheat-sheet.rst.txt → doc-cheat-sheet.rst b/doc-cheat-sheet.rst.txt → doc-cheat-sheet.rst