ggsql-python/great-docs.yml at main · posit-dev/ggsql-python · 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
117
# Great Docs Configuration
# See https://posit-dev.github.io/great-docs/user-guide/03-configuration.html

# Module Name (optional)
# ----------------------
# Set this if your importable module name differs from the project name.
# Example: project 'py-yaml12' with module name 'yaml12'
module: ggsql

# Docstring Parser
# ----------------
# The docstring format used in your package (numpy, google, or sphinx)
parser: numpy

# Dynamic Introspection
# ---------------------
# Use runtime introspection for more accurate documentation (default: true)
# Set to false if your package has cyclic alias issues (e.g., PyO3/Rust bindings)
dynamic: true

# Repo
# ----
repo: https://github.com/posit-dev/ggsql-python

# API Discovery Settings
# ----------------------
# Exclude items from auto-documentation
# exclude:
#   - InternalClass
#   - helper_function

# Logo & Favicon
# ---------------
# Point to a single logo file (replaces the text title in the navbar):
# logo: assets/logo.svg
#
# For light/dark variants:
# logo:
#   light: assets/logo-light.svg
#   dark: assets/logo-dark.svg
#
# To show the text title alongside the logo, add: show_title: true

authors:
  - name: Carson Sievert
    role: Lead Developer
    github: cpsievert

  - name: Thomas Lin Pedersen
    role: Contributor
    github: thomasp85

# Funding / Copyright Holder
# --------------------------
# Credit the organization that funds or holds copyright for this package.
# Displays in sidebar and footer. Homepage and ROR provide links.
funding:
  name: "Posit Software, PBC"
  roles:
    - Copyright holder
    - funder
  homepage: https://posit.co
  ror: https://ror.org/03wc8by49

# API Reference Structure
# -----------------------
# Customize the sections below to organize your API documentation.
# - Reorder items within a section to change their display order
# - Move items between sections or create new sections
# - Use 'members: false' to exclude methods from documentation
# - Add 'desc:' to sections for descriptions

reference:
  - title: High-level API
    desc: Convenience entry points for common workflows.
    contents:
      - render_altair
      - validate
      - execute
  - title: Readers
    desc: Execute SQL and manage DataFrames that feed visualizations.
    contents:
      - DuckDBReader
  - title: Writers
    desc: Turn a resolved Spec into rendered output.
    contents:
      - VegaLiteWriter
  - title: Result types
    desc: Objects returned from `validate()` and `reader.execute()`.
    contents:
      - Validated
      - Spec

# Site Settings
# -------------
site:
  theme: cosmo              # Quarto theme (default: flatly)
  toc: true                  # Show table of contents (default: true)
  toc-depth: 2               # TOC heading depth (default: 2)
  toc-title: On this page    # TOC title (default: "On this page")

navbar_color: "#DEF1EB"

# Jupyter Kernel
# --------------
# Jupyter kernel to use for executing code cells in .qmd files.
# This is set at the project level so it applies to all pages, including
# auto-generated API reference pages. Can be overridden in individual .qmd
# file frontmatter if needed for special cases.
jupyter: python3

# CLI Documentation
# -----------------
# cli:
#   enabled: true              # Enable CLI documentation
#   module: my_package.cli     # Module containing Click commands
#   name: cli                  # Name of the Click command object