sphinx_pickle_html_builder_serialized_documentation_output.py

1import os
2from sphinx.application import Sphinx
3from sphinxcontrib.serializinghtml import PickleHTMLBuilder
4
5# Define the source and output directories
6abs_path = os.path.abspath(".")
7src_dir = os.path.join(abs_path, "source")
8conf_dir = src_dir
9build_dir = os.path.join(abs_path, "build")
10doctree_dir = os.path.join(build_dir, "doctrees")
11out_dir = os.path.join(build_dir, "pickle")
12
13# Initialize the Sphinx application with the PickleHTMLBuilder
14app = Sphinx(
15    srcdir=src_dir,
16    confdir=conf_dir,
17    outdir=out_dir,
18    doctreedir=doctree_dir,
19    buildername="pickle"
20)
21
22# Run the build process
23if __name__ == "__main__":
24    app.build()