Skip to content

Commit 3237237

Browse files
committed
Improve documentation structure
1 parent b0ea8b0 commit 3237237

9 files changed

Lines changed: 44 additions & 4 deletions

File tree

File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. Graph Visualization for Python by Neo4j documentation master file, created by
2+
sphinx-quickstart on Fri Jan 10 13:54:11 2025.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
API Reference
7+
=====================================================
8+
9+
This is an API reference for the `neo4j-viz` library.
10+
11+
12+
.. toctree::
13+
:glob:
14+
:maxdepth: 1
15+
:caption: Contents:
16+
17+
*
File renamed without changes.

docs/source/getting-started.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Getting Started
2+
---------------

docs/source/index.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,18 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Graph Visualization for Python documentation
6+
Graph Visualization for Python by Neo4j documentation
77
=====================================================
88

9-
This API reference manual lists all available endpoints in the `neo4j_viz` `package <https://pypi.org/project/neo4j-viz/>`_.
9+
This is the documentation for the `neo4j_viz` Python library by Neo4j for creating interactive graph visualizations.
1010

1111

1212
.. toctree::
1313
:glob:
1414
:maxdepth: 1
1515
:caption: Contents:
1616

17-
*
18-
tutorials/*
17+
installation.rst
18+
getting-started.rst
19+
api-reference/index.rst
20+
tutorials/index.rst

docs/source/installation.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Installation
2+
------------

docs/source/tutorials/index.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. Graph Visualization for Python by Neo4j documentation master file, created by
2+
sphinx-quickstart on Fri Jan 10 13:54:11 2025.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Tutorials
7+
=====================================================
8+
9+
This chapter contains Jupyter notebook tutorials for the `neo4j_viz` package.
10+
11+
12+
.. toctree::
13+
:glob:
14+
:maxdepth: 1
15+
:caption: Contents:
16+
17+
*

0 commit comments

Comments
 (0)