mirror of
https://github.com/BoPeng/ai-marketplace-monitor.git
synced 2025-12-23 22:28:18 -05:00
105 lines
3.2 KiB
Python
105 lines
3.2 KiB
Python
"""Sphinx configuration."""
|
|
|
|
# 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
|
|
|
|
|
|
# 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 ai_marketplace_monitor
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
# General information about the project.
|
|
project = "ai-marketplace-monitor"
|
|
copyright = "2025, Bo Peng" # noqa: A001
|
|
author = "Bo Peng"
|
|
# The version info for the project you're documenting, acts as replacement
|
|
# for |version| and |release|, also used in various other places throughout
|
|
# the built documents.
|
|
#
|
|
# The short X.Y version.
|
|
version = ai_marketplace_monitor.__version__
|
|
# The full version, including alpha/beta/rc tags.
|
|
release = ai_marketplace_monitor.__version__
|
|
|
|
# -- 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.
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.viewcode",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx.ext.todo",
|
|
"sphinx.ext.coverage",
|
|
"sphinx.ext.imgmath",
|
|
"sphinx.ext.ifconfig",
|
|
"myst_parser",
|
|
]
|
|
|
|
# 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 = ["_build", "Thumbs.db", ".DS_Store"]
|
|
|
|
|
|
# -- 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 = "furo"
|
|
|
|
# Theme options are theme-specific and customize the look and feel of a theme
|
|
# further. For a list of options available for each theme, see the
|
|
# documentation.
|
|
html_theme_options = {
|
|
"source_repository": "https://github.com/BoPeng/ai-marketplace-monitor/",
|
|
"source_branch": "main",
|
|
"source_directory": "docs/",
|
|
"edit_page": True,
|
|
}
|
|
|
|
# Intersphinx configuration
|
|
intersphinx_mapping = {
|
|
"python": ("https://docs.python.org/3", None),
|
|
"playwright": ("https://playwright.dev/python/", None),
|
|
}
|
|
|
|
# MyST parser configuration
|
|
myst_enable_extensions = [
|
|
"colon_fence",
|
|
"deflist",
|
|
"html_admonition",
|
|
"html_image",
|
|
"linkify",
|
|
"replacements",
|
|
"smartquotes",
|
|
"substitution",
|
|
"tasklist",
|
|
]
|
|
|
|
# Additional HTML context
|
|
html_context = {
|
|
"display_github": True,
|
|
"github_user": "BoPeng",
|
|
"github_repo": "ai-marketplace-monitor",
|
|
"github_version": "main/docs/",
|
|
}
|
|
|
|
# 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"]
|