sphinx_conf_with_sphinxcontrib_devhelp_builder_setup.py

1# Configuration file for the Sphinx documentation builder.
2# To generate the devhelp files, run: sphinx-build -b devhelp . _build/devhelp
3
4import os
5import sys
6
7# -- Project information -----------------------------------------------------
8project = 'My Project'
9copyright = '2024, Author'
10author = 'Author'
11version = '0.1'
12release = '0.1.0'
13
14# -- General configuration ---------------------------------------------------
15
16# Add 'sphinxcontrib.devhelp' to extensions. 
17# Note: In modern Sphinx, this is often built-in or automatically loaded, 
18# but for the standalone contrib-package, ensure it is installed.
19extensions = [
20    'sphinxcontrib.devhelp',
21]
22
23# Add any paths that contain templates here, relative to this directory.
24templates_path = ['_templates']
25
26# List of patterns, relative to source directory, that match files and
27# directories to ignore when looking for source files.
28exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
29
30# -- Options for Devhelp output ----------------------------------------------
31
32# The basename for the Devhelp file.
33devhelp_basename = 'MyProject'
34
35# Optional: Set the path to the devhelp index file if needed.
36# devhelp_path = 'path/to/devhelp'