A Sphinx extension that enables watermarks for HTML output.
sphinxmark is an extension for Sphinx that enables watermarks for HTML output.
Full documentation: https://kallimachos.github.io/sphinxmark/
$ pip install sphinxmark
Open conf.py and 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']
watermark.css is recreated on each Sphinx run. Edits to this file are not retained.
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.
The extension provides a template css file that uses the specified image as the watermark for any area defined as div.body. Watermark will not work with themes that do not place body content in div.body. For this reason, watermark does not work with sphinx_rtd_theme.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|File Name & Checksum SHA256 Checksum Help||Version||File Type||Upload Date|
|sphinxmark-0.1.3-py2.py3-none-any.whl (29.8 kB) Copy SHA256 Checksum SHA256||py2.py3||Wheel||Aug 18, 2016|
|sphinxmark-0.1.3.tar.gz (29.6 kB) Copy SHA256 Checksum SHA256||–||Source||Aug 18, 2016|