Metadata-Version: 1.1
Name: sphinxmark
Version: 0.1.0
Summary: A Sphinx extension that enables watermarks for HTML output.
Home-page: https://github.com/kallimachos/sphinxmark
Author: Brian Moss
Author-email: kallimachos@gmail.com
License: GPLv3
Description: ==========
        sphinxmark
        ==========
        
        .. image:: https://travis-ci.org/kallimachos/sphinxmark.svg?branch=master
           :target: https://travis-ci.org/kallimachos/sphinxmark
        
        .. image:: https://img.shields.io/badge/Python-3.4-brightgreen.svg?style=flat
           :target: http://python.org
        
        .. image:: http://img.shields.io/badge/license-GPL-blue.svg?style=flat
           :target: http://opensource.org/licenses/GPL-3.0
        
        **sphinxmark** is an extension for Sphinx that enables watermarks for
        HTML output.
        
        Full documentation: https://kallimachos.github.io/sphinxmark/
        
        
        Usage
        ~~~~~
        
        #. Install sphinxmark:
        
           .. code::
        
              $ pip install sphinxmark
        
        #. Open ``conf.py`` and import sphinxmark:
        
           .. code::
        
              import sphinxmark
        
        #. Add watermark to the list of extensions in ``conf.py``:
        
           .. code::
        
              extensions = [
                 'sphinx.ext.autodoc',
                 'sphinx.ext.doctest',
                 'sphinxmark',
              ]
        
        #. Specify a static directory in ``conf.py`` for your watermark files. If the
           path does not exist, the watermark extension creates the directory and
           populates it with ``watermark.css`` and ``watermark-draft.png``:
        
           .. code::
        
              html_static_path = ['_static']
        
           .. note::
        
              ``watermark.css`` is recreated on each Sphinx run. Edits to this file
              are not retained.
        
        #. Configure watermark in ``conf.py`` as required:
        
           .. code::
        
              watermark_enable = True
              watermark_image = 'default'
              watermark_debug = False
        
        #. Put images in your static directory and edit ``watermark_image``
           to use custom watermarks.
        
        
        .. important::
        
           The extension provides a template css file that uses the specified image
           as the watermark for any area defined as ``div.body``. Watermark will not
           work with themes that do not place body content in ``div.body``. For this
           reason, watermark does not work with ``sphinx_rtd_theme``.
        
Keywords: sphinx documentation watermark
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Documentation :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
