From 235cc96181242996908f2e91dc1497e474efc7e6 Mon Sep 17 00:00:00 2001 From: Ben Burtenshaw Date: Thu, 11 Jul 2024 20:32:21 +0200 Subject: [PATCH] docs: make class toc consistent accross api references --- argilla/docs/reference/argilla/client.md | 5 ++-- .../argilla/datasets/dataset_records.md | 7 +++--- .../docs/reference/argilla/records/records.md | 7 +++--- .../reference/argilla/records/responses.md | 7 +++--- .../reference/argilla/records/suggestions.md | 7 +++--- .../docs/reference/argilla/records/vectors.md | 7 +++--- argilla/docs/reference/argilla/search.md | 10 ++++---- .../docs/reference/argilla/settings/fields.md | 5 ++-- .../argilla/settings/metadata_property.md | 13 +++++----- .../reference/argilla/settings/questions.md | 24 +++++++++++-------- .../reference/argilla/settings/settings.md | 7 +++--- .../reference/argilla/settings/vectors.md | 7 +++--- argilla/docs/reference/argilla/users.md | 7 +++--- argilla/docs/reference/argilla/workspaces.md | 7 +++--- 14 files changed, 57 insertions(+), 63 deletions(-) diff --git a/argilla/docs/reference/argilla/client.md b/argilla/docs/reference/argilla/client.md index e4be355557..147348f173 100644 --- a/argilla/docs/reference/argilla/client.md +++ b/argilla/docs/reference/argilla/client.md @@ -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 \ No newline at end of file diff --git a/argilla/docs/reference/argilla/datasets/dataset_records.md b/argilla/docs/reference/argilla/datasets/dataset_records.md index 5ae78d5d4d..e5e068aa0e 100644 --- a/argilla/docs/reference/argilla/datasets/dataset_records.md +++ b/argilla/docs/reference/argilla/datasets/dataset_records.md @@ -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 \ No newline at end of file + heading_level: 3 + show_root_toc_entry: false \ No newline at end of file diff --git a/argilla/docs/reference/argilla/records/records.md b/argilla/docs/reference/argilla/records/records.md index eaa19c36c0..12ff64ffeb 100644 --- a/argilla/docs/reference/argilla/records/records.md +++ b/argilla/docs/reference/argilla/records/records.md @@ -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 \ No newline at end of file + heading_level: 3 + show_root_toc_entry: false \ No newline at end of file diff --git a/argilla/docs/reference/argilla/records/responses.md b/argilla/docs/reference/argilla/records/responses.md index d1e9eb59bd..31b2c2160b 100644 --- a/argilla/docs/reference/argilla/records/responses.md +++ b/argilla/docs/reference/argilla/records/responses.md @@ -67,10 +67,9 @@ for record in dataset.records: --- -## Class Reference - -### `rg.Response` +## `rg.Response` ::: src.argilla.responses.Response options: - heading_level: 3 \ No newline at end of file + heading_level: 3 + show_root_toc_entry: false \ No newline at end of file diff --git a/argilla/docs/reference/argilla/records/suggestions.md b/argilla/docs/reference/argilla/records/suggestions.md index 012f19d77a..9fae2660ff 100644 --- a/argilla/docs/reference/argilla/records/suggestions.md +++ b/argilla/docs/reference/argilla/records/suggestions.md @@ -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 \ No newline at end of file + heading_level: 3 + show_root_toc_entry: false \ No newline at end of file diff --git a/argilla/docs/reference/argilla/records/vectors.md b/argilla/docs/reference/argilla/records/vectors.md index 5d8e8384f5..98c8f59d0f 100644 --- a/argilla/docs/reference/argilla/records/vectors.md +++ b/argilla/docs/reference/argilla/records/vectors.md @@ -67,10 +67,9 @@ dataset.records.log( --- -## Class Reference - -### `rg.Vector` +## `rg.Vector` ::: src.argilla.vectors.Vector options: - heading_level: 3 \ No newline at end of file + heading_level: 3 + show_root_toc_entry: false \ No newline at end of file diff --git a/argilla/docs/reference/argilla/search.md b/argilla/docs/reference/argilla/search.md index 7ed9df23a0..8821989d46 100644 --- a/argilla/docs/reference/argilla/search.md +++ b/argilla/docs/reference/argilla/search.md @@ -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 \ No newline at end of file + heading_level: 3 + show_root_toc_entry: false \ No newline at end of file diff --git a/argilla/docs/reference/argilla/settings/fields.md b/argilla/docs/reference/argilla/settings/fields.md index 5c30e222a5..0465f5dcb1 100644 --- a/argilla/docs/reference/argilla/settings/fields.md +++ b/argilla/docs/reference/argilla/settings/fields.md @@ -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 diff --git a/argilla/docs/reference/argilla/settings/metadata_property.md b/argilla/docs/reference/argilla/settings/metadata_property.md index 6f1cd4a7c0..3f66725026 100644 --- a/argilla/docs/reference/argilla/settings/metadata_property.md +++ b/argilla/docs/reference/argilla/settings/metadata_property.md @@ -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 \ No newline at end of file + heading_level: 3 + show_root_toc_entry: false \ No newline at end of file diff --git a/argilla/docs/reference/argilla/settings/questions.md b/argilla/docs/reference/argilla/settings/questions.md index a4f45b5b91..1b9e3f7292 100644 --- a/argilla/docs/reference/argilla/settings/questions.md +++ b/argilla/docs/reference/argilla/settings/questions.md @@ -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 \ No newline at end of file + heading_level: 3 + show_root_toc_entry: false \ No newline at end of file diff --git a/argilla/docs/reference/argilla/settings/settings.md b/argilla/docs/reference/argilla/settings/settings.md index 9510a6e18f..43d71154b8 100644 --- a/argilla/docs/reference/argilla/settings/settings.md +++ b/argilla/docs/reference/argilla/settings/settings.md @@ -34,10 +34,9 @@ dataset.create() --- -## Class Reference - -### `rg.Settings` +## `rg.Settings` ::: src.argilla.settings._resource.Settings options: - heading_level: 3 \ No newline at end of file + heading_level: 3 + show_root_toc_entry: false \ No newline at end of file diff --git a/argilla/docs/reference/argilla/settings/vectors.md b/argilla/docs/reference/argilla/settings/vectors.md index 91e0be3f05..5e76e75fd1 100644 --- a/argilla/docs/reference/argilla/settings/vectors.md +++ b/argilla/docs/reference/argilla/settings/vectors.md @@ -28,10 +28,9 @@ settings = rg.Settings( --- -## Class Reference - -### `rg.VectorField` +## `rg.VectorField` ::: src.argilla.settings._vector.VectorField options: - heading_level: 3 \ No newline at end of file + heading_level: 3 + show_root_toc_entry: false \ No newline at end of file diff --git a/argilla/docs/reference/argilla/users.md b/argilla/docs/reference/argilla/users.md index e91c58a10d..32a3ee6958 100644 --- a/argilla/docs/reference/argilla/users.md +++ b/argilla/docs/reference/argilla/users.md @@ -28,10 +28,9 @@ client.me --- -## Class Reference - -### `rg.User` +## `rg.User` ::: src.argilla.users._resource.User options: - heading_level: 3 \ No newline at end of file + heading_level: 3 + show_root_toc_entry: false \ No newline at end of file diff --git a/argilla/docs/reference/argilla/workspaces.md b/argilla/docs/reference/argilla/workspaces.md index dcd1b7a425..ecb245737e 100644 --- a/argilla/docs/reference/argilla/workspaces.md +++ b/argilla/docs/reference/argilla/workspaces.md @@ -23,10 +23,9 @@ workspace = client.workspaces("my_workspace") --- -## Class Reference - -### `rg.Workspace` +## `rg.Workspace` ::: src.argilla.workspaces._resource.Workspace options: - heading_level: 4 \ No newline at end of file + heading_level: 4 + show_root_toc_entry: false \ No newline at end of file