A Sphinx extension that enables watermarks for HTML output.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for kallimachos from gravatar.com kallimachos

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache 2.0)
  • Author: Brian Moss
  • Tags sphinx, documentation, watermark
Classifiers
Report project as malware

Project description

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page