summaryrefslogtreecommitdiff
path: root/doc/web/api.rst
diff options
context:
space:
mode:
authorDasIch <dasdasich@gmail.com>2010-08-10 17:11:11 +0200
committerDasIch <dasdasich@gmail.com>2010-08-10 17:11:11 +0200
commit8573faabb10140e1500cb6582ff7092805fc5bb1 (patch)
tree901d8c1989131cf38c5d26b8cc96c2d2890e7a61 /doc/web/api.rst
parentea4668abe4a075997d5c3dada219f851dc9e9505 (diff)
downloadsphinx-8573faabb10140e1500cb6582ff7092805fc5bb1.tar.gz
Removed trailing whitespace
Diffstat (limited to 'doc/web/api.rst')
-rw-r--r--doc/web/api.rst87
1 files changed, 43 insertions, 44 deletions
diff --git a/doc/web/api.rst b/doc/web/api.rst
index b2b7ef95..b63e6864 100644
--- a/doc/web/api.rst
+++ b/doc/web/api.rst
@@ -7,49 +7,49 @@ The WebSupport Class
.. class:: WebSupport
- The main API class for the web support package. All interactions
- with the web support package should occur through this class.
-
- The class takes the following keyword arguments:
-
- srcdir
- The directory containing reStructuredText source files.
-
- builddir
- The directory that build data and static files should be placed in.
- This should be used when creating a :class:`WebSupport` object that
- will be used to build data.
-
- datadir:
- The directory that the web support data is in. This should be used
- when creating a :class:`WebSupport` object that will be used to
- retrieve data.
-
- search:
- This may contain either a string (e.g. 'xapian') referencing a
- built-in search adapter to use, or an instance of a subclass of
- :class:`~sphinx.websupport.search.BaseSearch`.
-
- storage:
- This may contain either a string representing a database uri, or an
- instance of a subclass of
- :class:`~sphinx.websupport.storage.StorageBackend`. If this is not
- provided a new sqlite database will be created.
-
- moderation_callback:
- A callable to be called when a new comment is added that is not
- displayed. It must accept one argument: a dict representing the
- comment that was added.
-
- staticdir:
- If static files are served from a location besides "/static", this
- should be a string with the name of that location
- (e.g. '/static_files').
-
- docroot:
- If the documentation is not served from the base path of a URL, this
- should be a string specifying that path (e.g. 'docs')
-
+ The main API class for the web support package. All interactions
+ with the web support package should occur through this class.
+
+ The class takes the following keyword arguments:
+
+ srcdir
+ The directory containing reStructuredText source files.
+
+ builddir
+ The directory that build data and static files should be placed in.
+ This should be used when creating a :class:`WebSupport` object that
+ will be used to build data.
+
+ datadir:
+ The directory that the web support data is in. This should be used
+ when creating a :class:`WebSupport` object that will be used to
+ retrieve data.
+
+ search:
+ This may contain either a string (e.g. 'xapian') referencing a
+ built-in search adapter to use, or an instance of a subclass of
+ :class:`~sphinx.websupport.search.BaseSearch`.
+
+ storage:
+ This may contain either a string representing a database uri, or an
+ instance of a subclass of
+ :class:`~sphinx.websupport.storage.StorageBackend`. If this is not
+ provided a new sqlite database will be created.
+
+ moderation_callback:
+ A callable to be called when a new comment is added that is not
+ displayed. It must accept one argument: a dict representing the
+ comment that was added.
+
+ staticdir:
+ If static files are served from a location besides "/static", this
+ should be a string with the name of that location
+ (e.g. '/static_files').
+
+ docroot:
+ If the documentation is not served from the base path of a URL, this
+ should be a string specifying that path (e.g. 'docs')
+
Methods
~~~~~~~
@@ -64,4 +64,3 @@ Methods
.. automethod:: sphinx.websupport.WebSupport.process_vote
.. automethod:: sphinx.websupport.WebSupport.get_search_results
-