Use tags for references

argilla-io · Aug 12, 2024 · 4c2fac9 · 4c2fac9
1 parent e101eae
commit 4c2fac9
Show file tree

Hide file tree

Showing 18 changed files with 20 additions and 85 deletions.
diff --git a/argilla/docs/reference/argilla/client.md b/argilla/docs/reference/argilla/client.md
@@ -44,6 +44,4 @@ for dataset in my_workspace.datasets:
 
 ---
 
-##  `rg.Argilla`
-
 ::: src.argilla.client.Argilla
diff --git a/argilla/docs/reference/argilla/datasets/dataset_records.md b/argilla/docs/reference/argilla/datasets/dataset_records.md
@@ -215,6 +215,4 @@ Check out the [`rg.Record`](../records/records.md) class reference for more info
 
 ---
 
-##  `rg.Dataset.records`
-
 ::: src.argilla.records._dataset_records.DatasetRecords
diff --git a/argilla/docs/reference/argilla/datasets/datasets.md b/argilla/docs/reference/argilla/datasets/datasets.md
@@ -39,13 +39,9 @@ dataset = client.datasets("my_dataset")
 
 ---
 
-##  `rg.Dataset`
-
 ::: src.argilla.datasets._resource.Dataset
 
 ::: src.argilla.datasets._export._disk.DiskImportExportMixin
-    options:
-        show_root_heading: false
 
 ::: src.argilla.datasets._export._hub.HubImportExportMixin
 

diff --git a/argilla/docs/reference/argilla/records/metadata.md b/argilla/docs/reference/argilla/records/metadata.md
@@ -40,36 +40,36 @@ dataset_with_metadata.records.log(
 
 Depending on the `MetadataProperty` type, metadata might need to be formatted in a slightly different way.
 
-=== "For `FloatMetadataProperty`"
+=== "For `TermsMetadataProperty`"
 
     ```python
     rg.Records(
         fields={"text": "example"},
-        metadata={"category": 2.1}
+        metadata={"category": "A"}
     )
-    ```
 
-=== "For `IntegerMetadataProperty`"
+    # with multiple terms
 
-    ```python
     rg.Records(
         fields={"text": "example"},
-        metadata={"category": 42}
+        metadata={"category": ["A", "B"]}
     )
     ```
 
-=== "For `TermsMetadataProperty`"
+=== "For `FloatMetadataProperty`"
 
     ```python
     rg.Records(
         fields={"text": "example"},
-        metadata={"category": "A"}
+        metadata={"category": 2.1}
     )
+    ```
 
-    # with multiple terms
+=== "For `IntegerMetadataProperty`"
 
+    ```python
     rg.Records(
         fields={"text": "example"},
-        metadata={"category": ["A", "B"]}
+        metadata={"category": 42}
     )
-    ```
+    ```
diff --git a/argilla/docs/reference/argilla/records/records.md b/argilla/docs/reference/argilla/records/records.md
@@ -52,8 +52,5 @@ For changes to take effect, the user must call the `update` method on the `Datas
 
 ---
 
-## `rg.Record`
-
 ::: src.argilla.records._resource.Record
-    options:
-        heading_level: 3
+
diff --git a/argilla/docs/reference/argilla/records/responses.md b/argilla/docs/reference/argilla/records/responses.md
@@ -136,8 +136,5 @@ Depending on the `Question` type, responses might need to be formatted in a slig
 
 ---
 
-## `rg.Response`
-
 ::: src.argilla.responses.Response
-    options:
-        heading_level: 3
+
diff --git a/argilla/docs/reference/argilla/records/suggestions.md b/argilla/docs/reference/argilla/records/suggestions.md
@@ -152,8 +152,5 @@ Depending on the `Question` type, responses might need to be formatted in a slig
 
 ---
 
-## `rg.Suggestion`
-
 ::: src.argilla.suggestions.Suggestion
-    options:
-        heading_level: 3
+
diff --git a/argilla/docs/reference/argilla/records/vectors.md b/argilla/docs/reference/argilla/records/vectors.md
@@ -67,8 +67,5 @@ dataset.records.log(
 
 ---
 
-## `rg.Vector`
-
 ::: src.argilla.vectors.Vector
-    options:
-        heading_level: 3
+
diff --git a/argilla/docs/reference/argilla/search.md b/argilla/docs/reference/argilla/search.md
@@ -42,14 +42,6 @@ for record in dataset.records(query=query):
 
 ---
 
-## `rg.Query`
-
 ::: src.argilla.records._search.Query
-    options:
-        heading_level: 3
-
-## `rg.Filter`
 
-::: src.argilla.records._search.Filter
-    options:
-        heading_level: 3
+::: src.argilla.records._search.Filter
diff --git a/argilla/docs/reference/argilla/settings/fields.md b/argilla/docs/reference/argilla/settings/fields.md
@@ -35,6 +35,5 @@ data = rg.Dataset(
 
 ---
 
-## `rg.TextField`
 
 ::: src.argilla.settings._field.TextField
diff --git a/argilla/docs/reference/argilla/settings/metadata_property.md b/argilla/docs/reference/argilla/settings/metadata_property.md
@@ -62,16 +62,8 @@ dataset = rg.Dataset(
 
 ---
 
-## `rg.FloatMetadataProperty`
-
 ::: src.argilla.settings._metadata.FloatMetadataProperty
 
-
-## `rg.IntegerMetadataProperty`
-
 ::: src.argilla.settings._metadata.IntegerMetadataProperty
 
-
-## `rg.TermsMetadataProperty`
-
 ::: src.argilla.settings._metadata.TermsMetadataProperty
diff --git a/argilla/docs/reference/argilla/settings/questions.md b/argilla/docs/reference/argilla/settings/questions.md
@@ -49,30 +49,14 @@ dataset = rg.Dataset(
 
 ---
 
-## `rg.LabelQuestion`
-
 ::: src.argilla.settings._question.LabelQuestion
 
-
-## `rg.MultiLabelQuestion`
-
 ::: src.argilla.settings._question.MultiLabelQuestion
 
-
-## `rg.RankingQuestion`
-
 ::: src.argilla.settings._question.RankingQuestion
 
-## `rg.TextQuestion`
-
 ::: src.argilla.settings._question.TextQuestion
 
-
-## `rg.RatingQuestion`
-
 ::: src.argilla.settings._question.RatingQuestion
 
-
-## `rg.SpanQuestion`
-
 ::: src.argilla.settings._question.SpanQuestion
diff --git a/argilla/docs/reference/argilla/settings/settings.md b/argilla/docs/reference/argilla/settings/settings.md
@@ -34,8 +34,4 @@ dataset.create()
 
 ---
 
-## `rg.Settings`
-
 ::: src.argilla.settings._resource.Settings
-    options:
-        heading_level: 3
diff --git a/argilla/docs/reference/argilla/settings/task_distribution.md b/argilla/docs/reference/argilla/settings/task_distribution.md
@@ -34,6 +34,4 @@ dataset = rg.Dataset(
 
 ---
 
-## `rg.TaskDistribution`
-
 ::: src.argilla.settings._task_distribution.OverlapTaskDistribution
diff --git a/argilla/docs/reference/argilla/settings/vectors.md b/argilla/docs/reference/argilla/settings/vectors.md
@@ -28,6 +28,4 @@ settings = rg.Settings(
 
 ---
 
-## `rg.VectorField`
-
 ::: src.argilla.settings._vector.VectorField
diff --git a/argilla/docs/reference/argilla/users.md b/argilla/docs/reference/argilla/users.md
@@ -28,6 +28,4 @@ client.me
 
 ---
 
-##  `rg.User`
-
 ::: src.argilla.users._resource.User
diff --git a/argilla/docs/reference/argilla/workspaces.md b/argilla/docs/reference/argilla/workspaces.md
@@ -23,8 +23,6 @@ workspace = client.workspaces("my_workspace")
 
 ---
 
-## `rg.Workspace`
-
 ::: src.argilla.workspaces._resource.Workspace
     options:
         heading_level: 4
diff --git a/argilla/mkdocs.yml b/argilla/mkdocs.yml
@@ -132,12 +132,12 @@ plugins:
             show_source: true # include source code
             # Headings
             heading_level: 3
-            show_root_heading: false # show the python path of the class
-            show_root_toc_entry: false # show the toc entry for the root class
+            show_root_heading: true # show the python path of the class
+            show_root_toc_entry: true # show the toc entry for the root class
             show_root_full_path: false # display "diffrax.asdf" not just "asdf"
             show_object_full_path: false # display "diffrax.asdf" not just "asdf"
-            show_symbol_type_heading: false
-            show_symbol_type_toc: false
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
             # Members
             inherited_members: true # allow looking up inherited methods
             members_order: source # order methods according to their order of definition in the source code, not alphabetical order
Original file line number	Diff line number	Diff line change
Expand Up		@@ -44,6 +44,4 @@ for dataset in my_workspace.datasets:

		---

		## `rg.Argilla`

		::: src.argilla.client.Argilla
Original file line number	Diff line number	Diff line change
Expand Up		@@ -215,6 +215,4 @@ Check out the [`rg.Record`](../records/records.md) class reference for more info

		---

		## `rg.Dataset.records`

		::: src.argilla.records._dataset_records.DatasetRecords
Original file line number	Diff line number	Diff line change
Expand Up		@@ -35,6 +35,5 @@ data = rg.Dataset(

		---

		## `rg.TextField`

		::: src.argilla.settings._field.TextField
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,6 +34,4 @@ dataset = rg.Dataset(

		---

		## `rg.TaskDistribution`

		::: src.argilla.settings._task_distribution.OverlapTaskDistribution
Original file line number	Diff line number	Diff line change
Expand Up		@@ -28,6 +28,4 @@ settings = rg.Settings(

		---

		## `rg.VectorField`

		::: src.argilla.settings._vector.VectorField
Original file line number	Diff line number	Diff line change
Expand Up		@@ -28,6 +28,4 @@ client.me

		---

		## `rg.User`

		::: src.argilla.users._resource.User