a11y-for-devs/conf.py at main · comfort-mode-toolkit/a11y-for-devs · GitHub

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
80
81
82
# 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

project = 'a11y-for-devs'
copyright = '2025, Lalitha A R & Contributors'
author = 'Lalitha A R & Contributors'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = []

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 = 'alabaster'
html_static_path = ['_static']


html_title = 'Accessibility for Devs'
html_short_title = 'a11y-for-devs'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
    "sphinx_copybutton",
    # 'sphinxcontrib.googleanalytics',
    # "sphinx_sitemap"
]


# googleanalytics_id = "G-YK8NDXS8YW"

# templates_path = ['_templates']
# html_css_files = ['custom.css']
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 = 'furo'

pygments_style = "friendly"
pygments_dark_style = "github-dark"

# html_static_path = ['_static']
# html_favicon = "_static/logo.png"


# html_file_options = {
#     'description': 'Automatically fix hard-to-read text colors by making your website readable without changing your original color theme—simple Python API and CLI.',
#     'dark_mode_toggle': True,
# }

# html_meta = {
#     'description': 'Check color contrast and make text readable in seconds. Run local checks, automate accessibility in CI/CD, and instantly fix failing color pairs with Python or CLI.',
#     'keywords': 'check color contrast, make text readable, fix color contrast issues, WCAG compliance, accessibility',
#     'author': 'Lalitha A R & Contributors to cm-colors',
#     'viewport': 'width=device-width, initial-scale=1',
#     'robots': 'index, follow'
# }

# extensions.append('sphinxext.opengraph')
# ogp_site_url = 'https://cm-colors.readthedocs.io/'
# ogp_image = '_static/logo.png'

# sitemap_url_scheme = "{link}"
# html_baseurl = 'https://cm-colors.readthedocs.io/en/latest/'
# sitemap_filename = 'sitemap.xml'