sphinxmark 0.1.1

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/

Usage

1. Install sphinxmark:

   $ pip install sphinxmark

2. Add sphinxmark to the list of extensions in conf.py:

   extensions = [
      'sphinx.ext.autodoc',
      'sphinx.ext.doctest',
      'sphinxmark',
   ]

3. 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']

   Note

   watermark.css is recreated on each Sphinx run. Edits to this file are not retained.

4. Configure sphinxmark in conf.py as required:

   watermark_enable = True
   watermark_image = 'default'
   watermark_debug = False

5. Put images in your static directory and use the watermark_image option to specify a custom watermark image.

Important

The extension provides a template css file that uses the specified image as the watermark for any area defined as div.body. sphinxmark does not work with themes that do not place body content in div.body. For this reason, sphinxmark does not work with sphinx_rtd_theme.