François
617f599f86
- process.py: stop context_id engines in the inner finally block, before restore_gd() wipes _py_func_contexts/_lua_func_contexts from the global dict — engines were previously orphaned after every test run - py_func/tm.py: add user-facing docstrings to gd/setgd/delgd; remove internal JSON-serialization details from the docs - helper_lib.rst: auto-generate global variable helpers from py_func.tm (the actual subprocess API) instead of globdict - conf.py: add src/ to Sphinx sys.path so py_func.tm is importable - py_func_test_item.rst: simplify context sharing section, remove JSON-serializable/non-serializable distinction for end users - Regenerated PDF manual Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
86 lines
2.6 KiB
Python
86 lines
2.6 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
import os
|
|
|
|
import sys
|
|
sys.path.insert(0, os.path.abspath('../../../../src/testium/'))
|
|
sys.path.insert(0, os.path.abspath('../../../../src/'))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "testium"
|
|
copyright = "2025, François Dausseur"
|
|
author = "François Dausseur"
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
try:
|
|
release = os.environ["APP_VERSION"]
|
|
version = release
|
|
except:
|
|
raise Exception("APP_VERSION not defined in environment !")
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
master_doc = "index"
|
|
extensions = [
|
|
"sphinx.ext.duration",
|
|
"sphinx.ext.doctest",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.autosummary",
|
|
'linuxdoc.rstFlatTable',
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ["_templates"]
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
|
|
exclude_patterns = ["includes.rst", "templates.rst", "other_features.rst", "reports.rst"]
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
# html_theme = "alabaster"
|
|
html_theme = "classic"
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ["_static"]
|
|
|
|
numfig = True
|
|
|
|
latex_engine = "xelatex"
|
|
latex_elements = {
|
|
"papersize": "a4paper",
|
|
'fontpkg': r'''
|
|
\setmainfont{DejaVu Sans}
|
|
\setsansfont{DejaVu Sans}
|
|
\setmonofont{DejaVu Sans Mono}
|
|
'''
|
|
}
|
|
latex_show_urls = "footnote"
|
|
|
|
pdf_stylesheets = ["style_code_font_size"]
|
|
|
|
add_module_names = False # Remove namespaces from class/method signatures
|