Init api-ref docs for v2 endpoints

Author: FlorentinD

doc/sphinx/source/conf.py

@@ -25,13 +25,24 @@
     "sphinx.ext.autodoc",  # include docs from docstrings
     "enum_tools.autoenum",  # specialised autoclass for enums
     "sphinx.ext.napoleon",  # Support for NumPy and Google style docstrings
+    "sphinxcontrib.autodoc_pydantic",  # Support for Pydantic models
 ]
 
 autodoc_class_signature = "separated"
 
 templates_path = ["_templates"]
 exclude_patterns = []  # type: ignore
 
+# -- Options for Autodoc Pydantic ------------------------------------------------
+autodoc_pydantic_model_show_json = False
+autodoc_pydantic_settings_show_json = False
+autodoc_pydantic_model_show_config_summary = False
+autodoc_pydantic_model_show_field_summary = False
+autodoc_pydantic_field_show_alias = False
+autodoc_pydantic_field_show_required = False
+autodoc_pydantic_field_show_optional = False
+autodoc_pydantic_field_show_default = False
+
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 

doc/sphinx/source/index.rst

@@ -9,7 +9,7 @@ Neo4j Graph Data Science Python Client API Reference
 This API reference manual lists all available endpoints in the Neo4j Graph Data Science Python Client |api-version|.
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Contents
 
    graphdatascience
@@ -31,8 +31,5 @@ This API reference manual lists all available endpoints in the Neo4j Graph Data
    model/simple_rel_embedding_model
    misc
    server_version
-   sessions/gds_sessions
-   sessions/dbms_connection_info
-   sessions/session_memory
-   sessions/algorithm_category
-   sessions/cloud_location
+   sessions/index
+   v2_endpoints/index

doc/sphinx/source/sessions/aura_graphdatascience.rst

@@ -0,0 +1,7 @@
+AuraGraphDataScience
+--------------------
+
+.. autoclass:: graphdatascience.session.AuraGraphDataScience
+    :members:
+    :exclude-members: __init__
+    :inherited-members:

doc/sphinx/source/sessions/index.rst

@@ -0,0 +1,15 @@
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents
+
+   gds_sessions
+   dbms_connection_info
+   session_memory
+   algorithm_category
+   cloud_location
+   aura_graphdatascience
+
+.. toctree::
+   :hidden:
+
+   session_v2_endpoints

doc/sphinx/source/sessions/session_v2_endpoints.rst

@@ -0,0 +1,7 @@
+AuraGraphDataScience
+--------------------
+
+.. autoclass:: graphdatascience.session.session_v2_endpoints.SessionV2Endpoints
+    :members:
+    :exclude-members: __init__, set_progress
+    :inherited-members:

doc/sphinx/source/v2_endpoints/catalog_arrow_endpoints.rst

@@ -0,0 +1,6 @@
+Catalog Arrow Endpoints
+========================
+
+.. automodule:: graphdatascience.procedure_surface.arrow.catalog
+    :exclude-members: __init__
+    :members:

doc/sphinx/source/v2_endpoints/catalog_endpoints.rst

@@ -0,0 +1,6 @@
+Catalog Arrow Endpoints
+========================
+
+.. automodule:: graphdatascience.procedure_surface.api.catalog
+    :exclude-members: __init__
+    :members:

doc/sphinx/source/v2_endpoints/centrality_endpoints.rst

@@ -0,0 +1,6 @@
+Centrality Algorithms
+=======================
+
+.. automodule:: graphdatascience.procedure_surface.api.centrality
+    :members:
+    :exclude-members: __init__

doc/sphinx/source/v2_endpoints/community_endpoints.rst

@@ -0,0 +1,6 @@
+Community Algorithms
+====================
+
+.. automodule:: graphdatascience.procedure_surface.api.community
+    :members:
+    :exclude-members: __init__

doc/sphinx/source/v2_endpoints/estimation_result.rst

@@ -0,0 +1,6 @@
+Estimation Result
+=================
+
+.. automodule:: graphdatascience.procedure_surface.api.estimation_result
+    :members:
+