Skip to content

Commit

Permalink
docs: make class toc consistent accross api references
Browse files Browse the repository at this point in the history
  • Loading branch information
burtenshaw committed Jul 11, 2024
1 parent eae8c44 commit 235cc96
Show file tree
Hide file tree
Showing 14 changed files with 57 additions and 63 deletions.
5 changes: 2 additions & 3 deletions argilla/docs/reference/argilla/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,9 @@ for dataset in my_workspace.datasets:

---

## Class Reference

### `rg.Argilla`
## `rg.Argilla`

::: src.argilla.client.Argilla
options:
heading_level: 3
show_root_toc_entry: false
7 changes: 3 additions & 4 deletions argilla/docs/reference/argilla/datasets/dataset_records.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,10 +215,9 @@ Check out the [`rg.Record`](../records/records.md) class reference for more info

---

## Class Reference

### `rg.Dataset.records`
## `rg.Dataset.records`

::: src.argilla.records._dataset_records.DatasetRecords
options:
heading_level: 3
heading_level: 3
show_root_toc_entry: false
7 changes: 3 additions & 4 deletions argilla/docs/reference/argilla/records/records.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,9 @@ For changes to take effect, the user must call the `update` method on the `Datas

---

## Class Reference

### `rg.Record`
## `rg.Record`

::: src.argilla.records._resource.Record
options:
heading_level: 3
heading_level: 3
show_root_toc_entry: false
7 changes: 3 additions & 4 deletions argilla/docs/reference/argilla/records/responses.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,9 @@ for record in dataset.records:

---

## Class Reference

### `rg.Response`
## `rg.Response`

::: src.argilla.responses.Response
options:
heading_level: 3
heading_level: 3
show_root_toc_entry: false
7 changes: 3 additions & 4 deletions argilla/docs/reference/argilla/records/suggestions.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,9 @@ for record in dataset.records(with_suggestions=True):

---

## Class Reference

### `rg.Suggestion`
## `rg.Suggestion`

::: src.argilla.suggestions.Suggestion
options:
heading_level: 3
heading_level: 3
show_root_toc_entry: false
7 changes: 3 additions & 4 deletions argilla/docs/reference/argilla/records/vectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,9 @@ dataset.records.log(

---

## Class Reference

### `rg.Vector`
## `rg.Vector`

::: src.argilla.vectors.Vector
options:
heading_level: 3
heading_level: 3
show_root_toc_entry: false
10 changes: 5 additions & 5 deletions argilla/docs/reference/argilla/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,16 @@ for record in dataset.records(query=query):

---

## Class Reference

### `rg.Query`
## `rg.Query`

::: src.argilla.records._search.Query
options:
heading_level: 3
show_root_toc_entry: false

### `rg.Filter`
## `rg.Filter`

::: src.argilla.records._search.Filter
options:
heading_level: 3
heading_level: 3
show_root_toc_entry: false
5 changes: 2 additions & 3 deletions argilla/docs/reference/argilla/settings/fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,9 @@ data = rg.Dataset(
---

## Class References

### `rg.TextField`
## `rg.TextField`

::: src.argilla.settings._field.TextField
options:
heading_level: 3
show_root_toc_entry: false
13 changes: 7 additions & 6 deletions argilla/docs/reference/argilla/settings/metadata_property.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,22 +65,23 @@ dataset = rg.Dataset(
---

## Class References

### `rg.FloatMetadataProperty`
## `rg.FloatMetadataProperty`

::: src.argilla.settings._metadata.FloatMetadataProperty
options:
heading_level: 3
show_root_toc_entry: false

### `rg.IntegerMetadataProperty`
## `rg.IntegerMetadataProperty`

::: src.argilla.settings._metadata.IntegerMetadataProperty
options:
heading_level: 3
show_root_toc_entry: false

### `rg.TermsMetadataProperty`
## `rg.TermsMetadataProperty`

::: src.argilla.settings._metadata.TermsMetadataProperty
options:
heading_level: 3
heading_level: 3
show_root_toc_entry: false
24 changes: 14 additions & 10 deletions argilla/docs/reference/argilla/settings/questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,40 +53,44 @@ dataset = rg.Dataset(

---

## Class References

### `rg.LabelQuestion`
## `rg.LabelQuestion`

::: src.argilla.settings._question.LabelQuestion
options:
heading_level: 3

### `rg.MultiLabelQuestion`
show_root_toc_entry: false

## `rg.MultiLabelQuestion`

::: src.argilla.settings._question.MultiLabelQuestion
options:
heading_level: 3
show_root_toc_entry: false

### `rg.RankingQuestion`
## `rg.RankingQuestion`

::: src.argilla.settings._question.RankingQuestion
options:
heading_level: 3
show_root_toc_entry: false

### `rg.TextQuestion`
## `rg.TextQuestion`

::: src.argilla.settings._question.TextQuestion
options:
heading_level: 3
show_root_toc_entry: false

### `rg.RatingQuestion`
## `rg.RatingQuestion`

::: src.argilla.settings._question.RatingQuestion
options:
heading_level: 3
show_root_toc_entry: false

### `rg.SpanQuestion`
## `rg.SpanQuestion`

::: src.argilla.settings._question.SpanQuestion
options:
heading_level: 3
heading_level: 3
show_root_toc_entry: false
7 changes: 3 additions & 4 deletions argilla/docs/reference/argilla/settings/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,9 @@ dataset.create()
---

## Class Reference

### `rg.Settings`
## `rg.Settings`

::: src.argilla.settings._resource.Settings
options:
heading_level: 3
heading_level: 3
show_root_toc_entry: false
7 changes: 3 additions & 4 deletions argilla/docs/reference/argilla/settings/vectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,9 @@ settings = rg.Settings(
---

## Class Reference

### `rg.VectorField`
## `rg.VectorField`

::: src.argilla.settings._vector.VectorField
options:
heading_level: 3
heading_level: 3
show_root_toc_entry: false
7 changes: 3 additions & 4 deletions argilla/docs/reference/argilla/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,9 @@ client.me

---

## Class Reference

### `rg.User`
## `rg.User`

::: src.argilla.users._resource.User
options:
heading_level: 3
heading_level: 3
show_root_toc_entry: false
7 changes: 3 additions & 4 deletions argilla/docs/reference/argilla/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,9 @@ workspace = client.workspaces("my_workspace")

---

## Class Reference

### `rg.Workspace`
## `rg.Workspace`

::: src.argilla.workspaces._resource.Workspace
options:
heading_level: 4
heading_level: 4
show_root_toc_entry: false

0 comments on commit 235cc96

Please sign in to comment.