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
|
# 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
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
# -- Options for including images from README ----------------------------------
import os
import shutil
project = "stac-check"
copyright = "2025, Jonathan Healy"
author = "Jonathan Healy"
release = "1.11.1"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.viewcode",
"sphinx.ext.napoleon",
"sphinx_rtd_theme",
"sphinx.ext.intersphinx",
"myst_parser",
"sphinx_click",
]
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "sphinx_rtd_theme"
html_static_path = []
# Create _static directory if it doesn't exist
static_dir = os.path.join(os.path.dirname(__file__), "_static")
if not os.path.exists(static_dir):
os.makedirs(static_dir)
# Copy assets from project root to _static directory
assets_dir = os.path.join(os.path.dirname(os.path.dirname(__file__)), "assets")
if os.path.exists(assets_dir):
for file in os.listdir(assets_dir):
src = os.path.join(assets_dir, file)
dst = os.path.join(static_dir, file)
if os.path.isfile(src):
shutil.copy2(src, dst)
# Now that we've copied files, update static path
html_static_path = ["_static"]
myst_heading_anchors = 3 # Generate anchors for h1, h2, and h3
suppress_warnings = ["myst.header", "myst.xref_missing"]
# Configure myst-parser to handle images
myst_url_schemes = ("http", "https", "mailto", "ftp")
html_css_files = [
"custom.css",
]
|
