2010-06-04 16:13:53 -05:00
|
|
|
.. _websupportapi:
|
|
|
|
|
|
|
|
|
|
Web Support API
|
|
|
|
|
===============
|
|
|
|
|
|
|
|
|
|
.. module:: sphinx.websupport.api
|
|
|
|
|
.. class:: WebSupport
|
|
|
|
|
|
|
|
|
|
The :class:`WebSupport` class provides a central interface for
|
2010-06-16 08:41:43 -05:00
|
|
|
working with Sphinx documentation.
|
2010-06-04 16:13:53 -05:00
|
|
|
|
|
|
|
|
.. method:: init(srcdir='', outdir='')
|
|
|
|
|
|
|
|
|
|
Initialize attributes.
|
|
|
|
|
|
2010-06-26 14:49:30 -05:00
|
|
|
.. method:: build()
|
|
|
|
|
|
|
|
|
|
Build the data used by the web support package.
|
|
|
|
|
|
2010-06-04 16:13:53 -05:00
|
|
|
.. method:: get_document(docname)
|
|
|
|
|
|
2010-06-16 08:33:33 -05:00
|
|
|
Retrieve the context dictionary corresponding to the *docname*.
|
