Skip to main content

A Sphinx extension that enables watermarks for HTML output.

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.

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

Uploaded Source

Built Distribution

sphinxmark-1.0.0-py2.py3-none-any.whl (203.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: sphinxmark-1.0.0.tar.gz
  • Upload date:
  • Size: 205.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.26.0 setuptools/57.4.0 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.7

File hashes

Hashes for sphinxmark-1.0.0.tar.gz
Algorithm Hash digest
SHA256 f6057f32d2331692dd33fede98b7279afe9158d8508ffe3d878e5cb6b48eb687
MD5 41b60111cf55ca2f4d1fc539466ef9ae
BLAKE2b-256 abc39c027f5be3d0cc21d8f80dfe559b01def5279b1821dc68f1253e07029580

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinxmark-1.0.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 203.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.26.0 setuptools/57.4.0 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.7

File hashes

Hashes for sphinxmark-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d732fabe7759ed53fda77d8de7d441fb2e37404418e5faccf28178644d793854
MD5 7aa6f1f3125ac6020c56b097c7916b48
BLAKE2b-256 74c5b43ca62517d0e4da6ad6f7f4f5478dc75dfb977a096b6fe37dca386b2f33

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