This commit is contained in:
Chris Holdgraf
2020-07-23 17:39:20 -07:00
committed by Stephen Finucane
parent c7085162d1
commit 84f7dffd99
2 changed files with 22 additions and 5 deletions

View File

@@ -245,6 +245,26 @@ Now, you will have access to this function in jinja like so:
</div>
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:
.. code-block:: python
def copy_custom_files(app, exc):
if app.builder.format == 'html' and not exc:
staticdir = path.join(app.builder.outdir, '_static')
copy_asset_file('path/to/myextension/_static/myjsfile.js', staticdir)
def setup(app):
app.connect('builder-inited', copy_custom_files)
Inject JavaScript based on user configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@@ -9,17 +9,14 @@ fields marked up like this::
:fieldname: Field content
Field lists are :duref:`originally defined in docutils <bibliographic-fields>`
to show information about a page (such as the document author or date of
publication).
Sphinx extends standard docutils behavior for field lists and adds some extra
functionality that is covered in this section.
.. note::
The values of field lists will be parsed as
strings. You cannot use Python collections such as lists or dictionaries.
Sphinx treats field lists slightly differently, as explained
below.
.. _metadata: