Skip to content

Commit

Permalink
docs(api): expose relevant mixin members in temporal docs
Browse files Browse the repository at this point in the history
Explicitly listing out the members of `_DateComponentMixin` and
`_TimeComponentMixin` where relevant.

A bit verbose, but I also don't imagine these changing all that often.

Or maybe we can add support to `quartodoc` at some point to exclude
inheriting from certain parents?  dunno.
  • Loading branch information
gforsyth committed Feb 7, 2024
1 parent 6f32374 commit cb97806
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 4 deletions.
58 changes: 54 additions & 4 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -367,9 +367,60 @@ quartodoc:
name: Temporal expressions
desc: Dates, times, timestamps and intervals.
contents:
- TimestampValue
- DateValue
- TimeValue
- name: TimestampValue
members:
- add
- radd
- sub
- between
- bucket
- date
- day
- day_of_week
- day_of_year
- delta
- epoch_seconds
- hour
- microsecond
- millisecond
- minute
- month
- quarter
- second
- strftime
- time
- truncate
- week_of_year
- year
- name: DateValue
members:
- add
- radd
- sub
- day
- day_of_week
- day_of_year
- epoch_seconds
- month
- quarter
- strftime
- truncate
- week_of_year
- year
- name: TimeValue
members:
- add
- radd
- sub
- between
- hour
- microsecond
- millisecond
- minute
- second
- strftime
- time
- truncate
- IntervalValue
- DayOfWeek
- name: now
Expand All @@ -392,7 +443,6 @@ quartodoc:
package: ibis
dynamic: true
signature_name: full

- kind: page
path: expression-collections
package: ibis
Expand Down
5 changes: 5 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,11 @@ docs-render:
docs-preview:
quarto preview docs

# regen api and preview docs
docs-api-preview:
just docs-apigen --verbose
quarto preview docs

# deploy docs to netlify
docs-deploy:
quarto publish --no-prompt --no-browser --no-render netlify docs
Expand Down

0 comments on commit cb97806

Please sign in to comment.