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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: sphinxmark-0.2.1.tar.gz
  • Upload date:
  • Size: 201.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.24.0 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.2

File hashes

Hashes for sphinxmark-0.2.1.tar.gz
Algorithm Hash digest
SHA256 8d8ffb3384e5bfc289e0fb158cb13e0deb9d4712f45387ffc77b11f1e6d91f57
MD5 38f6c11e15281ce1a51f848bf9d315a3
BLAKE2b-256 d53aa172a7a14f144e5d875c914d6358c76215b30f7e121b22ef92e62edbabfc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinxmark-0.2.1-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.24.0 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.2

File hashes

Hashes for sphinxmark-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fe8b249214d64050a0c034cb292fca4ed97dd0689c92cf502b9aaa079640d46a
MD5 4e2a4260c703a83424612d3490b73025
BLAKE2b-256 71ad5fd8204ad1f0a50905d6a4f06ba579109eefc0aa1783e7de3ee98d5a60a3

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