Skip to content

Latest commit

 

History

History
60 lines (36 loc) · 1.44 KB

README.rst

File metadata and controls

60 lines (36 loc) · 1.44 KB

sphinxmark

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.

    Note

    Some Sphinx themes place body content in different CSS divs. See the sphinxmark documentation for full configuration details.