docs: update docs versions & template for docstrings (#97)

* docs: update docs versions & template for docstrings * docs: replace Roboto as font --------- Co-authored-by: Fabiana Clemente <[email protected]>
ydataai · May 24, 2024 · 1af02a6 · 1af02a6
1 parent 73e7283
commit 1af02a6
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 26 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -36,32 +36,32 @@ nav:
       - Components:
           - "sdk/modules/connectors.md"
       - Examples:
-        - Generate Tabular Data: "sdk/examples/synthesize_tabular_data.md"
-        - Generate Time-Series Data: "sdk/examples/synthesize_timeseries_data.md"
-        - Generate MultiTable Data: "sdk/examples/synthesizer_multitable.md"
-        - Anonymization: "sdk/examples/synthesize_with_anonymization.md"
-        - Privacy Level: "sdk/examples/synthesize_with_privacy_control.md"
-        - Conditional Sampling: "sdk/examples/synthesize_with_conditional_sampling.md"
+          - Generate Tabular Data: "sdk/examples/synthesize_tabular_data.md"
+          - Generate Time-Series Data: "sdk/examples/synthesize_timeseries_data.md"
+          - Generate MultiTable Data: "sdk/examples/synthesizer_multitable.md"
+          - Anonymization: "sdk/examples/synthesize_with_anonymization.md"
+          - Privacy Level: "sdk/examples/synthesize_with_privacy_control.md"
+          - Conditional Sampling: "sdk/examples/synthesize_with_conditional_sampling.md"
       - Reference:
-        - Changelog: 'sdk/reference/changelog.md'
-        - API:
-          - Client: 'sdk/reference/api/common/client.md'
-          - Connectors:
-              - 'Connector': 'sdk/reference/api/connectors/connector.md'
-          - DataSources:
-              - 'DataSource': 'sdk/reference/api/datasources/datasource.md'
-              - 'Metadata': 'sdk/reference/api/datasources/metadata.md'
-          - Synthesizers:
-              - Synthesizer: 'sdk/reference/api/synthesizers/base.md'
-              - Regular: 'sdk/reference/api/synthesizers/regular.md'
-              - TimeSeries: 'sdk/reference/api/synthesizers/timeseries.md'
-              - MultiTable: 'sdk/reference/api/synthesizers/multitable.md'
-          - Types: 'sdk/reference/api/common/types.md'
+          - Changelog: 'sdk/reference/changelog.md'
+          - API:
+              - Client: 'sdk/reference/api/common/client.md'
+              - Connectors:
+                  - 'Connector': 'sdk/reference/api/connectors/connector.md'
+              - DataSources:
+                  - 'DataSource': 'sdk/reference/api/datasources/datasource.md'
+                  - 'Metadata': 'sdk/reference/api/datasources/metadata.md'
+              - Synthesizers:
+                  - Synthesizer: 'sdk/reference/api/synthesizers/base.md'
+                  - Regular: 'sdk/reference/api/synthesizers/regular.md'
+                  - TimeSeries: 'sdk/reference/api/synthesizers/timeseries.md'
+                  - MultiTable: 'sdk/reference/api/synthesizers/multitable.md'
+              - Types: 'sdk/reference/api/common/types.md'
+
 
 theme:
   name: material
   language: en
-  font: 'Roboto'
   palette:
     - scheme: ydata
       media: "(prefers-color-scheme: light)"
@@ -150,7 +150,6 @@ plugins:
         lang: en
   - autorefs
   - mkdocstrings:
-      custom_templates: templates
       default_handler: python
       handlers:
         python:

diff --git a/pyproject.toml b/pyproject.toml
@@ -65,11 +65,12 @@ dev = [
     "mypy==1.3.0",
 ]
 doc = [
-    "mkdocs>=1.4.2,<1.5.2",
-    "mkdocs-material>=9.0.12,<9.2.7",
-    "mkdocs-material-extensions>=1.1.1,<2.0.0",
-    "mike>=1.1.2,<2.0.0",
+    "mkdocs>=1.6.0,<1.7.0",
+    "mkdocs-material>=9.0.12,<10.0.0",
+    "mkdocs-table-reader-plugin<=2.2.0",
+    "mike>=2.1.1,<2.2.0",
     "mkdocstrings[python]>=0.20.0,<1.0.0",
+    "mkdocs-badges"
 ]
 test = [
     "pytest==6.2.5",

diff --git a/templates/config.md b/templates/config.md
diff --git a/templates/python/config.md b/templates/python/config.md