diff options
author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-05-15 17:37:37 +0300 |
---|---|---|
committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-05-15 17:38:01 +0300 |
commit | c63d4741e9f7217f7db417eac05a225164cee7f7 (patch) | |
tree | 7dfbeff460fb72cebfc2b8979a771338bde348ca | |
parent | 23ab36bcd721128b46876eae6c3fdeef96885665 (diff) |
Fix #10344: docs: Update explanation for copying static files manually
-rw-r--r-- | doc/development/theming.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/development/theming.rst b/doc/development/theming.rst index f203429ac..6869aeffe 100644 --- a/doc/development/theming.rst +++ b/doc/development/theming.rst @@ -248,11 +248,11 @@ Now, you will have access to this function in jinja like so: Add your own static files to the build assets ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If you are packaging your own build assets with an extension -(e.g., a CSS or JavaScript file), you need to ensure that they are placed -in the ``_static/`` folder of HTML outputs. To do so, you may copy them directly -into a build's ``_static/`` folder at build time, generally via an event hook. -Here is some sample code to accomplish this: +By default, Sphinx copies static files on the ``static/`` directory of the template +directory. However, if your package needs to place static files outside of the +``static/`` directory for some reasons, you need to copy them to the ``_static/`` +directory of HTML outputs manually at the build via an event hook. Here is a sample +code to accomplish this: .. code-block:: python |