IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix #10344: docs: Update explanation for copying static files manually

Browse Source
This commit is contained in:
Takeshi KOMIYA 2022-05-15 23:37:37 +09:00
parent 23ab36bcd7
commit c63d4741e9
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/development/theming.rst
View File

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