Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/sphinx/source/_templates/gentree.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{%- extends "layout.html" %}
{% set title = _('Tree') %}
{% block body %}
<h1>{{ _('Tree') }}</h1>
{{ toctree(includehidden=True, collapse=False, maxdepth=-1) }}
{% endblock %}
20 changes: 20 additions & 0 deletions doc/sphinx/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,35 @@
"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

# use neo4j theme, which extends neo4j docs css for sphinx

html_theme = "neo4j"
html_theme_path = ["themes"]
html_theme_options = {
"sidebar_includehidden": True,
"sidebar_collapse": True,
}


# 01-nav.js is a copy of a js file of the same name that is included in the docs-ui bundle
Expand All @@ -48,6 +63,11 @@ def setup(app): # type: ignore
app.add_js_file("js/deprecated.js", loading_method="defer")


# Additional templates that should be rendered to pages, maps page names to
# template names.
html_additional_pages = {"gentree": "gentree.html"}


rst_epilog = """
.. |api-version| replace:: {versionnum}
""".format(
Expand Down
9 changes: 3 additions & 6 deletions doc/sphinx/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
7 changes: 7 additions & 0 deletions doc/sphinx/source/sessions/aura_graphdatascience.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
AuraGraphDataScience
--------------------

.. autoclass:: graphdatascience.session.AuraGraphDataScience
:members:
:exclude-members: __init__
:inherited-members:
15 changes: 15 additions & 0 deletions doc/sphinx/source/sessions/index.rst
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions doc/sphinx/source/sessions/session_v2_endpoints.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
AuraGraphDataScience
--------------------

.. autoclass:: graphdatascience.session.session_v2_endpoints.SessionV2Endpoints
:members:
:exclude-members: __init__, set_progress
:inherited-members:
13 changes: 13 additions & 0 deletions doc/sphinx/source/themes/neo4j/indexnav.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<div id="indexlinkbox">
<h3 id="indexlinklabel">{{ _('Index') }}</h3>

<div class="indexlinkwrapper nav-menu">
<ul>
<li class="toctree-l1">
<a href="{{ pathto('genindex')|e }}" class="indexlink genindex">
{{ _('Index') }}
</a>
</li>
</ul>
</div>
</div>
3 changes: 0 additions & 3 deletions doc/sphinx/source/themes/neo4j/navigation.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,3 @@
</div>
</aside>
</div>



Loading