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
Add sphinxmark 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 image files. If the path does not exist, the sphinxmark extension creates the directory and populates it with watermark.css and watermark-draft.png:
html_static_path = ['_static']
Configure sphinxmark in conf.py as required:
watermark_enable = True watermark_image = 'default' watermark_debug = False
Put images in your static directory and use the watermark_image option to specify a custom watermark image.
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
sphinxmark-0.1.1.tar.gz
(29.7 kB
view hashes)
Built Distribution
Close
Hashes for sphinxmark-0.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 91e02f5c093bdc9ec6bd4ffa2d30eb6e1c52a7d80d6eb9afc81fe11ddc86cd1a |
|
MD5 | 40404339780167f920938f73125e7be0 |
|
BLAKE2b-256 | dd6f07b74afd81b62c28c7777a8db897c269e15699e02608046cbcd81cdcb81f |