Overview

webmocks extension README

This is a sphinx extension which embeds web mock-ups .

source:

:Name: :text:`Input your name`
:Address: :text:`Input your address`

:button:`OK` :button:`Cancel`

rendered:

Name::text:`Input your name`
Address::text:`Input your address`

:button:`OK` :button:`Cancel`

Setting

You can get archive file at http://bitbucket.org/tk0miya/sphinxcontrib-webmocks/

Install

> easy_install sphinxcontrib-webmocks

Configure Sphinx

To enable this extension, add sphinxcontrib.webmocks module to extensions option at :file:`conf.py`.

import os, sys

# Path to the folder where webmocks.py is
# NOTE: not needed if the package is installed in traditional way
# using setup.py or easy_install
sys.path.append(os.path.abspath('/path/to/sphinxcontrib.webmocks'))

# Enabled extensions
extensions = ['sphinxcontrib.webmocks']

Roles

All roles create web input forms.

Directives

Repository

This code is hosted by Bitbucket.

http://bitbucket.org/tk0miya/sphinxcontrib-webmocks/