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-GPL-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.

Project details


Download files

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

Source Distribution

sphinxmark-0.1.7.tar.gz (199.9 kB view details)

Uploaded Source

Built Distribution

sphinxmark-0.1.7-py2.py3-none-any.whl (200.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinxmark-0.1.7.tar.gz.

File metadata

  • Download URL: sphinxmark-0.1.7.tar.gz
  • Upload date:
  • Size: 199.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for sphinxmark-0.1.7.tar.gz
Algorithm Hash digest
SHA256 4850a98158f7bcd5ae53ad92eda9a4992968577db36574570065a2fb2ce902aa
MD5 b5148e325a69c6a46def611751a1cd82
BLAKE2b-256 9431b8857a7ee3ed2487d7d5d5fffbee3f56f7c3aef2a7a2ed0cc1d035e21f87

See more details on using hashes here.

File details

Details for the file sphinxmark-0.1.7-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxmark-0.1.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0aa61125d74171dd3f92e0e2e786e09483a3d529cf1623f5626eae040bb28d94
MD5 c467567e09d7aee7c1cb2a60ccd3ce24
BLAKE2b-256 56421168872bcbc971f846c380531734a26134176330423476e922364a97092a

See more details on using hashes here.

Supported by

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