Skip to content

Commit

Permalink
feat: move to mintlify
Browse files Browse the repository at this point in the history
  • Loading branch information
mesejo committed Feb 20, 2025
1 parent 0c806fd commit 3fb2b6c
Show file tree
Hide file tree
Showing 49 changed files with 14,415 additions and 763 deletions.
25 changes: 0 additions & 25 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,26 +1 @@
.quarto
_site

*.ddb

site_libs

*.csv
*.parquet
*.delta
*.zip
*.db
diamonds.json
*.ndjson
reference/
objects.json

# generated notebooks and files
*.ipynb
*_files

# inventories
_inv
objects.txt

/.quarto/
32 changes: 32 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Mintlify Starter Kit

Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including

- Guide pages
- Navigation
- Customizations
- API Reference pages
- Use of popular components

### Development

Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command

```
npm i -g mintlify
```

Run the following command at the root of your documentation (where docs.json is)

```
mintlify dev
```

### Publishing Changes

Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.

#### Troubleshooting

- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
- Page loads as a 404 - Make sure you are running in a folder with `docs.json`
4 changes: 0 additions & 4 deletions docs/_publish.yml

This file was deleted.

76 changes: 68 additions & 8 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,10 @@ format:
include-in-header: "style/fontawesome.html"

quartodoc:
package: ibis
package: letsql
title: Reference
sidebar: reference/_sidebar.yml
render_interlinks: true
renderer: _renderer.py
options:
signature_name: short
sections:
Expand All @@ -90,7 +89,7 @@ quartodoc:
summary:
name: Table expressions
desc: Tables are one of the core data structures in Ibis.
package: ibis.expr.types.relations
package: letsql.vendor.ibis.expr.types.relations
contents:
- name: Table
members:
Expand All @@ -110,10 +109,12 @@ quartodoc:
- sql
- union
- view
- cache
- into_backend

- kind: page
path: expression-generic
package: ibis.expr.types.generic
package: letsql.vendor.ibis.expr.types.generic
summary:
name: Generic expressions
desc: Scalars and columns of any element type.
Expand Down Expand Up @@ -152,7 +153,7 @@ quartodoc:

- kind: page
path: expression-numeric
package: ibis.expr.types.numeric
package: letsql.vendor.ibis.expr.types.numeric
summary:
name: Numeric and Boolean expressions
desc: Integer, floating point, decimal, and boolean expressions.
Expand Down Expand Up @@ -201,7 +202,7 @@ quartodoc:

- kind: page
path: expression-strings
package: ibis.expr.types.strings
package: letsql.vendor.ibis.expr.types.strings
summary:
name: String expressions
desc: All string operations are valid for both scalars and columns.
Expand Down Expand Up @@ -247,7 +248,7 @@ quartodoc:

- kind: page
path: expression-temporal
package: ibis.expr.types.temporal
package: letsql.vendor.ibis.expr.types.temporal
summary:
name: Temporal expressions
desc: Dates, times, timestamps and intervals.
Expand Down Expand Up @@ -281,4 +282,63 @@ quartodoc:
- truncate
- name: IntervalValue
members:
- to_unit
- to_unit

- kind: page
path: toplevel-api
package: letsql.expr.api
summary:
name: Top Level API functions
contents:
- param
- schema
- table
- memtable
- desc
- asc
- preceding
- following
- and_
- or_
- random
- uuid
- case
- now
- today
- rank
- dense_rank
- percent_rank
- cume_dist
- ntile
- row_number
- read_csv
- read_parquet
- register
- read_postgres
- read_sqlite
- union
- intersect
- difference
- ifelse
- coalesce
- greatest
- least
- range
- timestamp
- date
- time
- interval
- to_sql
- execute
- to_pyarrow_batches
- to_pyarrow
- to_parquet
- get_plans

- kind: page
path: ml-api
package: letsql.expr.ml
summary:
name: ML API functions
contents:
- train_test_splits
96 changes: 0 additions & 96 deletions docs/_renderer.py

This file was deleted.

Loading

0 comments on commit 3fb2b6c

Please sign in to comment.