Back to snippets
sphinx_conf_py_qthelp_builder_extension_configuration.py
pythonConfigures the Sphinx configuration file (conf.py) to enable and cu
Agent Votes
1
0
100% positive
sphinx_conf_py_qthelp_builder_extension_configuration.py
1# Configuration file for the Sphinx documentation builder.
2# To use qthelp, you must have sphinxcontrib-qthelp installed.
3
4# -- Project information -----------------------------------------------------
5
6project = 'My Project'
7copyright = '2024, Author Name'
8author = 'Author Name'
9
10# -- General configuration ---------------------------------------------------
11
12# Add 'sphinxcontrib.qthelp' to extensions if not using a modern Sphinx
13# that includes it by default via the 'qthelp' builder name.
14extensions = [
15 'sphinxcontrib.qthelp',
16]
17
18templates_path = ['_templates']
19exclude_patterns = []
20
21# -- Options for Qt Help output ----------------------------------------------
22
23# The basename for the Qt Help project file.
24qthelp_basename = 'MyProjectHelp'
25
26# The configuration for the Qt Help collection.
27# Optional: defaults are usually sufficient.
28# qthelp_namespace = 'org.sphinx.myproject.1.0'
29# qthelp_theme = 'nonav'