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-2.7-brightgreen.svg?style=flat https://img.shields.io/badge/Python-3.4-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.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxmark-0.1.19-py2.py3-none-any.whl (201.1 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jul 4, 2017
sphinxmark-0.1.19.tar.gz (200.6 kB) Copy SHA256 hash SHA256 Source None Jul 4, 2017

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