docs-community/docs/conf.py at 11d219b71d15f8c04de7612e485351f25ab3ea2a · StanFromIreland/docs-community · 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
83
84
85
86
# Project information
# ===================
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "Documentation Community"
author = "Documentation Team"


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

# A list of strings that are module names of Sphinx extensions
import os
import sys

sys.path.append(os.path.abspath("tools/"))

extensions = [
    "sphinx_copybutton",
    "sphinx.ext.intersphinx",
    "myst_parser",
    "meeting_dates",
]

myst_enable_extensions = ["linkify"]

# The master toctree document
master_doc = "index"

# Patterns to exclude during source file detection
exclude_patterns = [
    "_build",
    "Thumbs.db",
    ".DS_Store",
    "include/minutes-template.md",
]

# Minimum Sphinx version as a string
needs_sphinx = "4.0"

# Intersphinx configuration
intersphinx_mapping = {
    "python": ("https://docs.python.org/3/", None),
    "devguide": ("https://devguide.python.org/", None),
    "pep": ("https://peps.python.org/", None),
}
intersphinx_disabled_reftypes = []

# Options for HTML output
# =======================
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

# The theme to use for HTML pages
html_theme = "furo"

html_title = "Python Docs Community Group"

# Options for the linkcheck builder
# =================================
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder

# A list of patterns to ignore when checking for broken links
linkcheck_ignore = [
    # The crawler gets "Anchor not found"
    r"https://github.com.+?#.*",
    r"https://hackmd\.io/[^?]+\?[^#]+#.+",
    # Google Meet gives 404
    r"https://meet.google.com/.*",
    # RTD preview builds:
    r"https://[a-zA-Z0-9.-]+\.org\.readthedocs\.build/[a-zA-Z0-9.-]+/[a-zA-Z0-9.-]+/",
    # Deleted pages:
    r"https://plausible\.io/share/hugovk-cpython\.readthedocs\.io\?auth=XDF9fK3EB2dEHCr4sC9hn",
    r"https://plausible.io/docs.python.org",
    r"https://plausible.io/packaging.python.org",
    r"https://us.pycon.org/2024/registration/category/4",
    # Have redirects:
    r"https://arewemeetingyet.com/.*",
    # Generated at build time:
    r"/docs-community-meetings.ics",
]

# A list of document names to exclude from linkcheck
linkcheck_exclude_documents = [
    r"monthly-meeting/.*",
]