diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 17:24:24 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 17:24:24 +0000 |
commit | 6c556df79380418667651b8011fc91dedc700a95 (patch) | |
tree | ba37dd06552873aa27b252df23efbfedf29ce4f9 /sphinxcontrib/jquery/__init__.py | |
parent | Initial commit. (diff) | |
download | sphinxcontrib-jquery-6c556df79380418667651b8011fc91dedc700a95.tar.xz sphinxcontrib-jquery-6c556df79380418667651b8011fc91dedc700a95.zip |
Adding upstream version 4.1.upstream/4.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'sphinxcontrib/jquery/__init__.py')
-rw-r--r-- | sphinxcontrib/jquery/__init__.py | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/sphinxcontrib/jquery/__init__.py b/sphinxcontrib/jquery/__init__.py new file mode 100644 index 0000000..e060cd7 --- /dev/null +++ b/sphinxcontrib/jquery/__init__.py @@ -0,0 +1,53 @@ +from os import makedirs, path +import shutil + +import sphinx + +__version__ = "4.1" +version_info = (4, 1) + +_ROOT_DIR = path.abspath(path.dirname(__file__)) +_FILES = ( + ( + 'jquery.js', + 'sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK', + ), + ( + '_sphinx_javascript_frameworks_compat.js', + 'sha384-lSZeSIVKp9myfKbDQ3GkN/KHjUc+mzg17VKDN4Y2kUeBSJioB9QSM639vM9fuY//', + ), +) + + +def add_js_files(app, config): + jquery_installed = getattr(app, "_sphinxcontrib_jquery_installed", False) + + if sphinx.version_info[:2] >= (6, 0) and not jquery_installed: + makedirs(path.join(app.outdir, '_static'), exist_ok=True) + for (filename, integrity) in _FILES: + # The default is not to enable subresource integrity checks, as it + # does not trigger the hash check but instead blocks the request + # when viewing documentation locally through the ``file://`` URIs. + if config.jquery_use_sri: + app.add_js_file(filename, priority=100, integrity=integrity) + else: + app.add_js_file(filename, priority=100) + shutil.copyfile( + path.join(_ROOT_DIR, filename), + path.join(app.outdir, '_static', filename) + ) + app._sphinxcontrib_jquery_installed = True + + +def setup(app): + # Configuration value for enabling `subresource integrity`__ (SRI) checks + # __ https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity + app.add_config_value("jquery_use_sri", default=False, rebuild="html", types=(bool,)) + + app.connect('config-inited', add_js_files) + + return { + "parallel_read_safe": True, + "parallel_write_safe": True, + "version": __version__, + } |