DOC: link to a local file name with spaces

spatialaudio · Feb 3, 2024 · 8796068 · 8796068
1 parent 3bc9d54
commit 8796068
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/doc/markdown-cells.ipynb b/doc/markdown-cells.ipynb
@@ -627,7 +627,15 @@
     "\n",
     "The linked files are automatically copied to the HTML output directory.\n",
     "For LaTeX output, links are created,\n",
-    "but the files are not copied to the target directory."
+    "but the files are not copied to the target directory.\n",
+    "\n",
+    "You should try to avoid spaces in file names,\n",
+    "but if you insist, you'll have to replace the spaces with `%20` in the link:\n",
+    "[a file with spaces in its name](subdir/a%20file%20name%20with%20spaces.txt).\n",
+    "\n",
+    "```\n",
+    "[a file with spaces in its name](subdir/a%20file%20name%20with%20spaces.txt)\n",
+    "```"
    ]
   },
   {

diff --git a/doc/subdir/a file name with spaces.txt b/doc/subdir/a file name with spaces.txt
@@ -0,0 +1 @@
+You should avoid spaces in file names!