sphinx-contrib / email /

Filename Size Date modified Message
..
sphinxcontrib
33 B
752 B
115 B
1.1 KB
=========================
 sphinxcontrib-email
=========================

This package contains sphinxcontrb.email, an email obfuscator for
Sphinx-based documentation.


Installation
============

1. ``pip install sphinxcontrib-email``

Configuration
=============

1. Add ``'sphinxcontrib.email'`` to the ``extensions`` list in ``conf.py``.

  ::

    extensions = [ 'sphinxcontrib.email' ]


Usage
=====

To obfuscate an email address use something like::

    :email:`Name Surname <user@myplace.org>`
    :email:`Name Surname (user@myplace.org)`

Renders as "Name Surname" with the appropriate mailto link.

    :email:`user@myplace.org`

Renders as "user@myplace.org" with the appropriate mailto link

History
=======

0.1
  First public release.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.