
wuxi
====

Build Sphinx Docs using Django Templates


About
-----

By default, Sphinx uses Jinja2 for templating, but can be configured to use other
template engines. ``wuxi`` is a proof of concept TemplateBridge for Sphinx that
allows you to replace Jinja2 templates with Django templates. 


Usage
-----

After installing ``wuxi``, edit your Sphinx ``conf.py``to include the following::

    from os.path import dirname, abspath, join as pathjoin
    import wuxi

    wuxi_theme_dir = pathjoin(dirname(abspath(wuxi.__file__)), 'themes')

    html_theme_path = [wuxi_theme_dir]

    html_theme = 'sphinxdoc'

    template_bridge = 'wuxi.bridge.DjangoTemplateBridge'

    extensions = ['wuxi']


Only the ``default`` and ``sphinxdoc`` themes have been ported. Contributions of other
themes are welcome.


Requirements
------------

``wuxi`` requires the ``django-sans`` library.


Development
-----------

::

    pip install -e svn+http://pyfilesystem.googlecode.com/svn/trunk#egg=pyfilesystem
    pip install -e hg+ssh://hg@bitbucket.org/worrp/django-sans@tip#egg=django-sans
    pip install -e hg+ssh://hg@bitbucket.org/worrp/wuxi@tip#egg=wuxi


Contact
-------

contact /at/ worrp.com



