sphinxcontrib_websupport_init_build_and_document_retrieval.py

1import os
2from sphinxcontrib.websupport import WebSupport
3
4# Settings for the WebSupport object
5support = WebSupport(
6    srcdir='/path/to/source',
7    builddir='/path/to/build',
8    search='xapian',  # or 'whoosh'
9    storage='sqlalchemy',
10    storage_args={'url': 'sqlite:///db.sqlite'}
11)
12
13# Build the documentation
14support.build()
15
16# Retrieve a document for display in a web application
17# This returns a dictionary with 'body', 'title', etc.
18document = support.get_document('index')