serpapi-search-tools-python/great-docs.yml at main · serpapi/serpapi-search-tools-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/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: serpapi_search_tools
display_name: serpapi-search-tools

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

# Dynamic Introspection
# ---------------------
# Use runtime introspection for accurate signatures and source links (default: true).

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

# Logo & Favicon
# ---------------
# Show the project title beside the official SerpApi mark.
logo:
  light: assets/serpapi-logo.svg
  dark: assets/serpapi-logo.svg
  show_title: true
favicon: assets/serpapi-logo.svg

# Keep the authored user-guide homepage instead of generating a logo hero.
hero: false

# Author Information
# ------------------
# Author metadata for display in the landing page sidebar
# You can add additional fields: github, orcid, affiliation, homepage
authors:
  - name: SerpApi
    role: Developer
    email: contact@serpapi.com
    homepage: https://serpapi.com

# 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

# Site URL
# --------
# Canonical address of the deployed documentation site.
# Required for subdirectory deployments, skills page install commands,
# .well-known/ discovery, and sitemaps.
# site_url: "https://your-org.github.io/your-package/"
repo: https://github.com/serpapi/serpapi-search-tools-python
site_url: "https://serpapi.github.io/serpapi-search-tools-python/"
source:
  path: src/serpapi_search_tools
dark_mode_toggle: true
homepage: user_guide
sections:
  - title: Cookbook
    dir: docs/cookbook
    index: true
    index_columns: 2
  - title: Examples
    dir: docs/sdk_examples
    index: true
    index_columns: 2
user_guide: docs/user_guide

# Site Settings
# -------------
# site:
#   theme: flatly              # 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")
site:
  theme: flatly
  toc: true
  toc-depth: 2

# Project-owned responsive fixes. The inline loaders use Quarto's page offset,
# so the same assets work from the homepage and nested documentation pages.
include_in_header:
  - text: >-
      <script>document.head.appendChild(Object.assign(document.createElement('link'),{rel:'stylesheet',href:(document.querySelector('meta[name="quarto:offset"]')||{content:''}).content+'assets/docs-mobile.css?v=3'}));</script>
  - text: >-
      <script>(function(){var s=document.createElement('script');var m=document.querySelector('meta[name="quarto:offset"]');s.src=(m?m.content:'')+'assets/docs-mobile.js?v=4';s.defer=true;document.head.appendChild(s);})();</script>

# 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