From c63d4741e9f7217f7db417eac05a225164cee7f7 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 15 May 2022 23:37:37 +0900 Subject: [PATCH 1/2] Fix #10344: docs: Update explanation for copying static files manually --- doc/development/theming.rst | 10 +++++----- 1 file 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 From e6f07c7381bad26175916afb0928d2098ebcf03d Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 22 May 2022 13:34:21 +0900 Subject: [PATCH 2/2] doc: Fix syntax error Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --- doc/development/theming.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/development/theming.rst b/doc/development/theming.rst index 6869aeffe..fcbeb030a 100644 --- a/doc/development/theming.rst +++ b/doc/development/theming.rst @@ -251,8 +251,8 @@ Add your own static files to the build assets 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: +directory of HTML outputs manually at the build via an event hook. Here is an +example of code to accomplish this: .. code-block:: python