final update

Laure-di · Laure-di · commit 388926aa29e7 · 2025-01-06T17:25:42.000+01:00
diff --git a/docs/_templates/autoapi/index.rst b/docs/_templates/autoapi/index.rst
@@ -1,8 +1,13 @@
-===================================
-Scaleway SDK Python Documentations
-===================================
+API Reference
+=============
+
+This page contains auto-generated API reference documentation [#f1]_.
 
 .. toctree::
-   :maxdepth: 4
+   :titlesonly:
+
+   {% for page in pages|selectattr("is_top_level_object") %}
+   {{ page.include_path }}
+   {% endfor %}
 
-   autoapi/index
+.. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_
diff --git a/docs/_templates/autoapi/macros.rst b/docs/_templates/autoapi/macros.rst
@@ -2,8 +2,8 @@
 {% macro auto_summary(objs, title='') -%}
 
 .. list-table:: {{ title }}
-    :header-rows: 0
-    :widths: auto
+   :header-rows: 0
+   :widths: auto
 
 {% for obj in objs %}
     * - obj.name
diff --git a/docs/_templates/autoapi/python/attribut.rst b/docs/_templates/autoapi/python/attribut.rst
diff --git a/docs/_templates/autoapi/python/attribute.rst b/docs/_templates/autoapi/python/attribute.rst
@@ -0,0 +1 @@
+{% extends "python/data.rst" %}
diff --git a/docs/_templates/autoapi/python/class.rst b/docs/_templates/autoapi/python/class.rst
@@ -1,4 +1,3 @@
-{% import 'macros.rst' as macros %}
 {% if obj.display %}
    {% if is_own_page %}
 {{ obj.id }}
@@ -82,7 +81,9 @@ Classes
 
 .. autoapisummary::
 
-         {{ macros.auto_summary(visible_classes, title="Classes") }}
+         {% for klass in visible_classes %}
+   {{ klass.id }}
+         {% endfor %}
 
 
       {% endif %}
@@ -100,4 +101,4 @@ Methods
 
       {% endif %}
    {% endif %}
-{% endif %}
+{% endif %}
diff --git a/docs/_templates/autoapi/python/data.rst b/docs/_templates/autoapi/python/data.rst
@@ -35,4 +35,4 @@
 
    {{ obj.docstring|indent(3) }}
    {% endif %}
-{% endif %}
+{% endif %}
diff --git a/docs/_templates/autoapi/python/exception.rst b/docs/_templates/autoapi/python/exception.rst
@@ -1 +1 @@
-{% extends "python/class.rst" %}
+{% extends "python/class.rst" %}
diff --git a/docs/_templates/autoapi/python/function.rst b/docs/_templates/autoapi/python/function.rst
@@ -18,4 +18,4 @@
 
    {{ obj.docstring|indent(3) }}
    {% endif %}
-{% endif %}
+{% endif %}
diff --git a/docs/_templates/autoapi/python/method.rst b/docs/_templates/autoapi/python/method.rst
@@ -18,4 +18,4 @@
 
    {{ obj.docstring|indent(3) }}
    {% endif %}
-{% endif %}
+{% endif %}
diff --git a/docs/_templates/autoapi/python/module.rst b/docs/_templates/autoapi/python/module.rst
@@ -1,4 +1,3 @@
-{% import 'macros.rst' as macros %}
 {% if obj.display %}
    {% if is_own_page %}
 {{ obj.id }}
@@ -92,12 +91,16 @@ Classes
 .. toctree::
    :hidden:
 
-                    {{ macros.auto_summary(visible_classes, title="Classes") }}
+                     {% for klass in visible_classes %}
+   {{ klass.include_path }}
+                     {% endfor %}
 
                   {% endif %}
 .. autoapisummary::
 
-                  {{ macros.auto_summary(visible_classes, title="Classes") }}
+                  {% for klass in visible_classes %}
+   {{ klass.id }}
+                  {% endfor %}
                {% endif %}
 
 
@@ -150,4 +153,4 @@ Functions
    {{ obj_item.render()|indent(3) }}
       {% endfor %}
    {% endif %}
-{% endif %}
+{% endif %}
diff --git a/docs/_templates/autoapi/python/package.rst b/docs/_templates/autoapi/python/package.rst
@@ -1 +1 @@
-{% extends "python/module.rst" %}
+{% extends "python/module.rst" %}
diff --git a/docs/_templates/autoapi/python/property.rst b/docs/_templates/autoapi/python/property.rst
@@ -18,4 +18,4 @@
 
    {{ obj.docstring|indent(3) }}
    {% endif %}
-{% endif %}
+{% endif %}
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,6 @@
+===================================
+Scaleway SDK Python Documentations
+===================================
+
+.. toctree::
+   :maxdepth: 4
diff --git a/docs/poetry.lock b/docs/poetry.lock
diff --git a/docs/pyproject.toml b/docs/pyproject.toml
@@ -4,6 +4,7 @@ version = "2.7.0"
 description = ""
 authors = ["Scaleway <opensource@scaleway.com>"]
 license = "BSD"
+readme = "README.md"
 
 [tool.poetry.dependencies]
 python = ">=3.10"
@@ -12,10 +13,10 @@ furo = "^2024.8.6"
 scaleway-core = { path = "../scaleway-core", develop = true }
 scaleway = { path = "../scaleway", develop = true }
 scaleway-async = { path = "../scaleway-async", develop = true }
-sphinx-autoapi = "^3.1.0"
+sphinx-autoapi = "^3.4.0"
 sphinx-copybutton = "^0.5.2"
 
 
 [build-system]
 requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+build-backend = "poetry.core.masonry.api"

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{% extends "python/class.rst" %}`
	`1`	`+{% extends "python/class.rst" %}`