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-07 16:09:19 -05:00
|
|
|
working with :class:`~sphinx.websupport.document.Document`'s.
|
2010-06-04 16:13:53 -05:00
|
|
|
|
|
|
|
|
.. method:: init(srcdir='', outdir='')
|
|
|
|
|
|
|
|
|
|
Initialize attributes.
|
|
|
|
|
|
|
|
|
|
.. method:: get_document(docname)
|
|
|
|
|
|
|
|
|
|
Retrieve the :class:`~sphinx.websupport.document.Document` object
|
|
|
|
|
corresponding to the *docname*.
|
|
|
|
|
|
|
|
|
|
.. module:: sphinx.websupport.document
|
|
|
|
|
.. class:: Document
|
|
|
|
|
|
|
|
|
|
The :class:`Document` provides access to a single document. It
|
|
|
|
|
is not instantiated directly, but is returned by methods of the
|
|
|
|
|
:class:`~sphinx.websupport.api.WebSupport` object.
|
