Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

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

  1. Install sphinxmark:

    $ pip install sphinxmark
    
  2. Open conf.py and import sphinxmark:

    import sphinxmark
    
  3. Add watermark to the list of extensions in conf.py:

    extensions = [
       'sphinx.ext.autodoc',
       'sphinx.ext.doctest',
       'sphinxmark',
    ]
    
  4. 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']
    

    Note

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

  5. Configure watermark in conf.py as required:

    watermark_enable = True
    watermark_image = 'default'
    watermark_debug = False
    
  6. Put images in your static directory and edit watermark_image to use custom watermarks.

Important

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.

Release History

Release History

This version
History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download Files

Download Files

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

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting