Skip to content

Commit

Permalink
docs(reference): place objects in ibis when possible
Browse files Browse the repository at this point in the history
Now random shows up as `ibis.random` instead of `ibis.expr.api.random`.

Some of these objects fail to be found if they are put under ibis,
so they have to stay under ibis.expr.api. This seems to be if the object is defined
statically in the module, rather than imported from another module.
than dynamically
such as
`ifelse = _deferred(ir.BooleanValue.ifelse)`

Maybe deal with that later, but at least improve things for now.

Also, don't specify the package at higher levels of the module,
only at the lowest common
denominator.
There is no visibale change to this, just less code.
  • Loading branch information
NickCrews committed Sep 27, 2023
1 parent 554c73a commit b3429e9
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,6 @@ quartodoc:
sections:
- title: Expression API
desc: "APIs for manipulating table, column and scalar expressions"
package: ibis.expr.types
contents:
- kind: page
package: ibis
Expand All @@ -197,7 +196,7 @@ quartodoc:
desc: Create and manage backend connections.
contents:
- name: connect
package: ibis.backends.base
dynamic: true
- name: get_backend
dynamic: true
- name: set_backend
Expand Down Expand Up @@ -269,7 +268,7 @@ quartodoc:
- Column
- Scalar
- name: literal
package: ibis.expr.api
package: ibis
dynamic: true
- name: param
package: ibis
Expand Down Expand Up @@ -319,12 +318,15 @@ quartodoc:
- name: BooleanValue
package: ibis.expr.types.logical
- name: and_
package: ibis
dynamic: true
- name: or_
package: ibis
dynamic: true
- name: negate
package: ibis.expr.api
- name: random
package: ibis
dynamic: true

- kind: page
Expand Down Expand Up @@ -421,7 +423,6 @@ quartodoc:

- title: Type System
desc: "Data types and schemas"
package: ibis
contents:
- kind: page
path: datatypes
Expand Down

0 comments on commit b3429e9

Please sign in to comment.