Code Listing¶

A Sphinx extension that enables watermarks for HTML output.

Project Source: https://github.com/JoKneeMo/sphinx-watermark

Copyright 2024 - JoKneeMo

Licensed under GNU General Public License version 3 (GPLv3).

Commit 0762fdef2eabead5edf99e393becc2cd5a926f11 and older are licensed under Apache License, Version 2.0 and copyrighten 2021 by Brian Moss

Original project: https://github.com/kallimachos/sphinxmark

__init__.createimage(app: Sphinx, srcdir: Path, buildpath: Path) → str[source]¶

Create PNG image from string.

__init__.deep_update(source, overrides)[source]¶

Update a nested dictionary or similar mapping. Modify source in place.

__init__.generate_css(app: Sphinx, buildpath: str, imagefile: str) → str[source]¶

Create CSS file.

__init__.generate_watermark(app: Sphinx, env: BuildEnvironment) → None[source]¶

Generate watermark

__init__.get_image(app: Sphinx) → tuple[source]¶

Get image file.

__init__.setup(app: Sphinx) → dict[source]¶

Configure setup for Sphinx extension.

Parameters:¶

app: Sphinx¶

Sphinx application context.