From 5a63c2970f99d39a0202174454bd7452f7f79643 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 21 Apr 2018 11:02:46 +0900 Subject: [PATCH] doc: Add a note for dotfiles on html_static_path (refs: #4859) --- doc/config.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/config.rst b/doc/config.rst index 1c8ae48e0..a0cdbe709 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -877,6 +877,18 @@ that use Sphinx's HTMLWriter class. named :file:`default.css` will overwrite the theme's :file:`default.css`. + .. note:: + + For security reason, dotfiles under ``html_static_path`` will + not be copied. If you'd like to copy them intentionally, please + add them each filepath to this setting:: + + html_static_path = ['_static', '_static/.htaccess'] + + Another way to do that, you can also use + :confval:`html_extra_path`. It allows to copy dotfiles under + the directories. + .. versionchanged:: 0.4 The paths in :confval:`html_static_path` can now contain subdirectories.