1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
|
# 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
from __future__ import annotations
import sys
from pathlib import Path
from subprocess import run
import sphinxext.opengraph
# -- Path setup --------------------------------------------------------------
sys.path.insert(0, str(Path(__file__).parent.parent))
# -- Project information -----------------------------------------------------
project = 'sphinxext-opengraph'
copyright = (
'2020, FIRST',
'2025-%Y, the Sphinx developers',
)
version = sphinxext.opengraph.__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.intersphinx',
'sphinx_design',
'sphinxext.opengraph',
]
# 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 = []
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_title = 'sphinxext-opengraph'
html_logo = '_static/og-logo.png'
html_theme = 'furo'
intersphinx_mapping = {
'sphinx': ('https://www.sphinx-doc.org/', None),
}
# -- Configuration for this theme --------------------------------------------
ogp_site_url = 'https://sphinxext-opengraph.readthedocs.io/en/latest/'
# Configuration for testing but generally we use the defaults
# Uncomment lines to see their effect.
ogp_social_cards = {
'site_url': 'sphinxext-opengraph.readthedocs.io',
# "image": "TODO: add another image to test",
# "line_color": "#4078c0",
}
# Generate sample social media preview images
path_script = Path(
__file__, '..', 'script', 'generate_social_card_previews.py'
).resolve()
run((sys.executable, path_script), check=False) # NoQA: S603
|