Merge pull request #4875 from tk0miya/4859_update_docs

doc: Add a note for dotfiles on html_static_path (refs: #4859)
This commit is contained in:
Takeshi KOMIYA 2018-04-22 18:33:39 +09:00 committed by GitHub
commit bed764316f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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.