Skip to main content

A Sphinx extension that enables watermarks for HTML output.

Project description

https://travis-ci.org/kallimachos/sphinxmark.svg?branch=master https://img.shields.io/pypi/status/sphinxmark.svg?style=flat https://img.shields.io/pypi/v/sphinxmark.svg?style=flat https://img.shields.io/badge/Python-3.7-brightgreen.svg?style=flat http://img.shields.io/badge/license-apache-blue.svg?style=flat

sphinxmark is an extension for Sphinx that enables watermarks for HTML output.

Full documentation: https://kallimachos.github.io/sphinxmark/

Installation

Install sphinxmark using pip:

$ pip install sphinxmark

Usage

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

    extensions = ['sphinxmark']
    
  2. Enable sphinxmark in conf.py:

    sphinxmark_enable = True
    
  3. Build your docs as normal. A DRAFT watermark now appears behind the text.

    Note

    Some Sphinx themes place body content in different CSS divs. See the sphinxmark documentation for full configuration details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxmark, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxmark-0.2.0-py2.py3-none-any.whl (203.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size sphinxmark-0.2.0.tar.gz (200.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page