Skip to content

Commit

Permalink
docs: default to short signature but show full path for top level fun…
Browse files Browse the repository at this point in the history
…ctions
  • Loading branch information
cpcloud committed Oct 1, 2023
1 parent 66a58e2 commit 9793862
Showing 1 changed file with 45 additions and 1 deletion.
46 changes: 45 additions & 1 deletion docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ quartodoc:
render_interlinks: true
renderer: _renderer.py
options:
signature_name: full
signature_name: short
sections:
- title: Expression API
desc: "APIs for manipulating table, column and scalar expressions"
Expand All @@ -202,34 +202,49 @@ quartodoc:
package: ibis.expr.types.groupby
- name: read_csv
dynamic: true
signature_name: full
- name: read_delta
dynamic: true
signature_name: full
- name: read_json
dynamic: true
signature_name: full
- name: read_parquet
dynamic: true
signature_name: full
- name: memtable
dynamic: true
signature_name: full
- name: table
dynamic: true
signature_name: full
- name: difference
dynamic: true
signature_name: full
- name: intersect
dynamic: true
signature_name: full
- name: union
dynamic: true
signature_name: full
- name: row_number
dynamic: true
signature_name: full
- name: window
dynamic: true
signature_name: full
- name: cumulative_window
dynamic: true
signature_name: full
- name: range_window
dynamic: true
signature_name: full
- name: trailing_range_window
dynamic: true
signature_name: full
- name: trailing_window
dynamic: true
signature_name: full

- kind: page
path: expression-generic
Expand All @@ -245,31 +260,44 @@ quartodoc:
package: ibis.expr.types.generic
- name: literal
dynamic: true
signature_name: full
- name: param
dynamic: true
signature_name: full
- name: NA
# Ideally exposed under `ibis` but that doesn't seem to work??
package: ibis.expr.api
signature_name: full
- name: "null"
dynamic: true
signature_name: full
- name: coalesce
dynamic: true
signature_name: full
- name: least
dynamic: true
signature_name: full
- name: greatest
dynamic: true
signature_name: full
- name: asc
dynamic: true
signature_name: full
- name: desc
dynamic: true
signature_name: full
- name: ifelse
dynamic: true
signature_name: full
- name: case
dynamic: true
signature_name: full
- name: show_sql
dynamic: true
signature_name: full
- name: to_sql
dynamic: true
signature_name: full

- kind: page
path: expression-numeric
Expand All @@ -293,10 +321,13 @@ quartodoc:
package: ibis.expr.types.logical
- name: and_
dynamic: true
signature_name: full
- name: or_
dynamic: true
signature_name: full
- name: random
dynamic: true
signature_name: full

- kind: page
path: expression-strings
Expand All @@ -322,18 +353,23 @@ quartodoc:
- name: now
package: ibis
dynamic: true
signature_name: full
- name: date
package: ibis
dynamic: true
signature_name: full
- name: time
package: ibis
dynamic: true
signature_name: full
- name: timestamp
package: ibis
dynamic: true
signature_name: full
- name: interval
package: ibis
dynamic: true
signature_name: full

- kind: page
path: expression-collections
Expand All @@ -350,10 +386,13 @@ quartodoc:
package: ibis.expr.types.structs
- name: array
dynamic: true
signature_name: full
- name: map
dynamic: true
signature_name: full
- name: struct
dynamic: true
signature_name: full

- kind: page
path: expression-geospatial
Expand Down Expand Up @@ -403,6 +442,7 @@ quartodoc:
- name: dtype
package: ibis
dynamic: true
signature_name: full
- Array
- Binary
- Boolean
Expand Down Expand Up @@ -445,6 +485,7 @@ quartodoc:
contents:
- name: schema
dynamic: true
signature_name: full
- name: Schema
package: ibis.expr.schema

Expand All @@ -458,10 +499,13 @@ quartodoc:
contents:
- name: connect
dynamic: true
signature_name: full
- name: get_backend
dynamic: true
signature_name: full
- name: set_backend
dynamic: true
signature_name: full

- title: UDFs
desc: "User-defined function APIs"
Expand Down

0 comments on commit 9793862

Please sign in to comment.