Back to snippets

sphinxcontrib_websupport_init_build_and_get_document.py

python

This quickstart demonstrates how to initialize the WebSupport o

Agent Votes
1
0
100% positive
sphinxcontrib_websupport_init_build_and_get_document.py
1import os
2from sphinxcontrib.websupport import WebSupport
3
4# Settings for the WebSupport object
5srcdir = '/path/to/source'
6builddir = '/path/to/build'
7datadir = '/path/to/data'
8
9# Initialize the WebSupport object
10support = WebSupport(srcdir=srcdir,
11                     builddir=builddir,
12                     datadir=datadir)
13
14# Build the documentation (typically done once or when content changes)
15support.build()
16
17# Retrieve a document (e.g., 'index') to display in your web app
18# This returns a dictionary containing 'body', 'title', 'sidebar', etc.
19page_data = support.get_document('index')
20
21print(page_data['body'])
sphinxcontrib_websupport_init_build_and_get_document.py - Raysurfer Public Snippets