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.

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

Uploaded Source

Built Distribution

sphinxmark-0.2.0-py2.py3-none-any.whl (203.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: sphinxmark-0.2.0.tar.gz
  • Upload date:
  • Size: 200.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for sphinxmark-0.2.0.tar.gz
Algorithm Hash digest
SHA256 2d4c291e78395802ec4e19e9c3bdf92063967e4e99f51b1a6a6a094cfee8402a
MD5 8870c334724f359e0abe96889c6904d8
BLAKE2b-256 c724db0d2201a5a01c096985d6399c3df400f1ddad0ce50811768c798a26cd74

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinxmark-0.2.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 203.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.31.1 CPython/3.7.2

File hashes

Hashes for sphinxmark-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 aa0b14389d0cfd09700c96d53a5f42f4c4cb4b495cf3ade50045812d8e98c2f3
MD5 d6598fc0e6506813baf1c3ce1e775804
BLAKE2b-256 671054dfc1c2daf9ab933f770cf576cf12a383cc313c68756ae0db5650d0687f

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