Something went wrong. Try again.
Command line interface for accessing the Open Web Index shards and slices.
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051# Configuration file for the Sphinx documentation builder.## For the full list of built-in configuration values, see the documentation:# https://www.sphinx-doc.org/en/master/usage/configuration.html
import osimport sysfrom pathlib import Path
# -- Path Setup --------------------------------------------------------------# Adjust paths to allow imports from your packagesys.path.insert(0, os.path.abspath('../..'))sys.path.insert(0, str(Path(__file__).parents[3]))
# -- Project Information -----------------------------------------------------project = 'Owilix'copyright = '2024, Michael Granitzer'author = 'Michael Granitzer'
# Use the package version (from owilix.__version__)from owilix import __version__ # noqa: E402version = release = __version__
# -- General Configuration ---------------------------------------------------extensions = [ 'myst_parser', 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', # For Google/Numpy-style docstrings 'sphinx.ext.viewcode', # Add links to source code 'sphinx_multiversion', # Versioned documentation support]
templates_path = ['_templates']exclude_patterns = []
# -- Sphinx-Multiversion Configuration ---------------------------------------# Control which versions are includedsmmap_tag_whitelist = r'^v\d+\.\d+\.\d+$' # Match release tags (vX.Y.Z)smv_branch_whitelist = r'^main$' # Only include main branch as "latest"smv_released_pattern = r'^v\d+\.\d+\.\d+$' # Only released versions (tags)smv_outputdir_format = '{ref.name}' # Output dir format (e.g., "v1.0.0")
# -- HTML Output Configuration -----------------------------------------------html_theme = 'sphinxdoc'html_static_path = ['_static']
# Optional: Theme-specific options (for dropdown)html_theme_options = { # 'version_dropdown': True, # Removed as unsupported by sphinxdoc theme # Add other theme-specific options here}