python-switch/great-docs.yml at master · mikeckennedy/python-switch · 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
# Great Docs Configuration
# See https://posit-dev.github.io/great-docs/user-guide/configuration.html
#
# Built site is mirrored into the committed repo-root docs/ folder by
# scripts/build_docs.py and served by nginx at /docs/python-switch.

display_name: switchlang

# Docstring format used in switchlang (":param x:" / ":return:" style).
# Pinned rather than relying on auto-detect.
parser: sphinx

# Runtime introspection — requires switchlang to be importable in this venv
# (it is installed editable via the [dev] extra).
dynamic: true

# Subpath hosting: drives Quarto's base path so CSS/JS/nav resolve.
# Keep the trailing slash.
site_url: "https://mkennedy.codes/docs/python-switch/"

# GOTCHA: sitemap/robots/canonical/og:url use a SEPARATE base URL that
# Great Docs auto-detects from the GitHub repo (-> mikeckennedy.github.io)
# and does NOT fall back to site_url. Set it explicitly or the sitemap
# points at the wrong domain.
seo:
  canonical:
    base_url: "https://mkennedy.codes/docs/python-switch/"

repo: https://github.com/mikeckennedy/python-switch
github_style: widget

# NOTE: this repo's default branch is "master", not "main".
source: { enabled: true, branch: master, placement: usage }

pypi: true

# GOTCHA: Great Docs defaults mcp.enabled to TRUE, rendering an empty "MCP"
# tab even when the project ships no MCP server. Disable it.
mcp:
  enabled: false

# Umami analytics — merged into Quarto's format.html.include-in-header, so it lands in
# the <head> of every generated page.
include_in_header:
  - text: |
      <script async src="https://uma.mkennedy.codes/script.js" data-website-id="fc9b6770-3b44-4073-944e-4a4f0e79f66a"></script>

# Changelog is hand-maintained in the repo-root CHANGELOG.md (Keep a Changelog
# format) — that file is the single source of truth, NOT GitHub Releases.
# Disable Great Docs' release-driven changelog and render CHANGELOG.md instead
# via the "Changelog" section below; scripts/build_docs.py stages the file into
# changelog/index.qmd before each build.
changelog:
  enabled: false

# Custom sections. The Changelog section renders the staged CHANGELOG.md as a
# first-class page with its own navbar link (placed after the API Reference).
sections:
  - title: Changelog
    dir: changelog
    navbar_after: Reference

# Author metadata for display in the landing page sidebar
authors:
  - name: Michael Kennedy
    role: Author
    email: michael@talkpython.fm
    github: mikeckennedy
    homepage: https://mkennedy.codes

# API Reference Structure
# -----------------------
reference:
  - title: The switch block
    desc: >
      The context manager that gives Python an explicit switch statement.
      Use it in a `with` block, register cases, then read `result`.
    contents:
      - switch

  - title: Range helpers
    desc: >
      Helpers for mapping ranges of values to a single case.
    contents:
      - closed_range

# Jupyter kernel used by Quarto for any executable code cells.
jupyter: python3