A Sphinx extension that enables watermarks for HTML output.
Project description
sphinxmark is an extension for Sphinx that enables watermarks for HTML output.
Full documentation: https://kallimachos.github.io/sphinxmark/
Usage
Install sphinxmark:
$ pip install sphinxmark
Open conf.py and import sphinxmark:
import sphinxmark
Add watermark to the list of extensions in conf.py:
extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinxmark', ]
Specify a static directory in conf.py for your watermark files. If the path does not exist, the watermark extension creates the directory and populates it with watermark.css and watermark-draft.png:
html_static_path = ['_static']
Configure watermark in conf.py as required:
watermark_enable = True watermark_image = 'default' watermark_debug = False
Put images in your static directory and edit watermark_image to use custom watermarks.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxmark-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62258ac79390e4179629930f6448e88f7cc7e6a576835b5c56ddb428ed069f67 |
|
MD5 | 57a719c5f42a97a267ecdf3405dafa0b |
|
BLAKE2b-256 | 7d9086bb3c15f61a72b0aee6f79ff887351ce135ce5d079f7011b108e222b759 |