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.8.tar.gz (200.0 kB view details)

Uploaded Source

Built Distribution

sphinxmark-0.1.8-py2.py3-none-any.whl (200.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinxmark-0.1.8.tar.gz
Algorithm Hash digest
SHA256 280ebb69455ecd41662b6e1b4ff29c7f9a8c9ad819a7ae22d7f36b0520130d58
MD5 be8580b8c3b085a810cba2702ef96f50
BLAKE2b-256 653da8ec69528ac3ba174d2443498ce7febbb66e5d29bc36fa16625f55c077c8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinxmark-0.1.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 700de07038817a59c6108b3503129a4cc3fc6b6a9f93288675eb299d39f96f53
MD5 c0759c8c9a7298e22453aed8b6dd4d49
BLAKE2b-256 04c48b5ba082ec9116fe798e26af9e82a6801f4f9ccdfae5e47683f3c56f0a24

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