community-landing/conf.py at main · readthedocs/community-landing · 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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
"""Read the Docs documentation landing page."""

import re


def build_project(
    *,
    name: str,
    meta: str,
    meta_url: str,
    description: str,
    base_url: str,
    default_version: str,
    versions: list[dict],
    default_language: str = "",
) -> dict:
    base_url = base_url.rstrip("/")
    rendered_versions = []
    primary_url = ""
    for version in versions:
        language = version.get("language", "")
        version_name = version.get("version", "latest")
        parts = [base_url]
        if language:
            parts.append(language)
        parts.append(version_name)
        version_url = "/".join(parts) + "/index.html"
        if version_name == default_version and language == default_language:
            primary_url = version_url
        rendered_versions.append(
            {
                "language": language,
                "version": version_name,
                "url": version_url,
                "show_language": bool(language and language != "en"),
            }
        )
    if not primary_url and rendered_versions:
        primary_url = rendered_versions[0]["url"]
    return {
        "name": name,
        "meta": meta,
        "meta_url": meta_url,
        "description": description,
        "url": primary_url,
        "versions": rendered_versions,
        "topics": [],
    }


project = "Read the Docs"
slug = re.sub(r"[^\w\s]", "", project)
copyright = "2026, Read the Docs, Inc"
author = "Read the Docs, Inc"

language = "en"
version = "1.0"
release = version

extensions = []

templates_path = ["_templates"]
source_suffix = ".rst"
master_doc = "index"
exclude_patterns = ["_build", ".venv", "README.rst"]
pygments_style = "sphinx"

html_theme = "landing"
html_theme_path = ["_themes"]
html_theme_options = {
    "description": "Documentation landing page and metadata.",
}
html_additional_pages = {
    "index": "landing.html",
}
html_logo = "_themes/landing/static/img/logo.svg"
html_extra_path = ["_extra"]

html_context = {
    "projects": [
        build_project(
            name="Platform documentation",
            meta="readthedocs/readthedocs.org",
            meta_url="https://github.com/readthedocs/readthedocs.org",
            description="Guides, reference, and API docs for Read the Docs.",
            base_url="https://docs.readthedocs.com/platform",
            default_version="stable",
            versions=[
                {"language": "", "version": "stable"},
            ],
        ),
        build_project(
            name="Development documentation",
            meta="readthedocs/readthedocs.org",
            meta_url="https://github.com/readthedocs/readthedocs.org",
            description="Developer-focused documentation and internal workflows.",
            base_url="https://docs.readthedocs.com/dev",
            default_version="latest",
            versions=[
                {"language": "", "version": "latest"},
            ],
        ),
    ],
}

# Output formats
htmlhelp_basename = f"{slug}doc"

latex_elements = {}
latex_documents = [(master_doc, f"{slug}.tex", project, author, "manual")]

man_pages = [(master_doc, slug, project, [author], 1)]

texinfo_documents = [
    (master_doc, slug, project, author, slug, project, "Miscellaneous"),
]