IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-09-03 20:52:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Lots of documentation and a few small API changes

Browse Source
This commit is contained in:
Jacob Mason
2010-07-12 01:41:39 -05:00
parent a1c99c9603
commit cf06e98ebd
4 changed files with 346 additions and 223 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/web/api.rst
+21 -11
View File
@@ -1,22 +1,32 @@
.. _websupportapi:
Web Support API
===============
.. currentmodule:: sphinx.websupport
The WebSupport Class
====================
.. module:: sphinx.websupport.api
.. class:: WebSupport
The :class:`WebSupport` class provides a central interface for
working with Sphinx documentation.
The main API class for the web support package. All interactions
with the web support package should occur through this class.
.. method:: init(srcdir='', outdir='')
:param srcdir: the directory containing the reStructuredText files
:param outdir: the directory in which to place the built data
:param search: the search system to use
:param comments: an instance of a CommentBackend
Methods
~~~~~~~
Initialize attributes.
.. automethod:: sphinx.websupport.WebSupport.build
.. method:: build()
.. automethod:: sphinx.websupport.WebSupport.get_document
Build the data used by the web support package.
.. automethod:: sphinx.websupport.WebSupport.get_comments
.. method:: get_document(docname)
.. automethod:: sphinx.websupport.WebSupport.add_comment
.. automethod:: sphinx.websupport.WebSupport.process_vote
.. automethod:: sphinx.websupport.WebSupport.get_search_results
Retrieve the context dictionary corresponding to the *docname*.