Skip to content

Commit 31ac85b

Browse files
nvitucciFlorentinD
andauthored
Improve docs structure (#256)
* Move integration page under directory * Add integration pages * Simplify installation instructions * Rework intro * More fixes * Apply suggestions from code review Co-authored-by: Florentin Dörre <florentin@owitsch.de> --------- Co-authored-by: Florentin Dörre <florentin@owitsch.de>
1 parent 64ba0b8 commit 31ac85b

File tree

13 files changed

+304
-331
lines changed

13 files changed

+304
-331
lines changed
Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
* xref:index.adoc[]
22
* xref:installation.adoc[]
33
* xref:getting-started.adoc[]
4-
* xref:integration.adoc[]
54
* xref:rendering.adoc[]
65
* xref:customizing.adoc[]
6+
* xref:integration/index.adoc[]
7+
** xref:integration/gds.adoc[]
8+
** xref:integration/neo4j.adoc[]
9+
** xref:integration/snowflake.adoc[]
10+
** xref:integration/gql.adoc[]
11+
** xref:integration/pandas.adoc[]
712
* link:{tutorials-docs-uri}[Tutorials]
813
* link:{api-docs-uri}[API reference]

docs/antora/modules/ROOT/pages/customizing.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If you have not yet created a `VisualizationGraph` object, refer to one of the f
1010
* xref:getting-started.adoc[Getting started] for creating a visualization graph from scratch using `neo4j-viz`
1111
primitives like link:{api-docs-uri}/node/[Node] and link:{api-docs-uri}/relationship/[Relationship] and
1212
link:{api-docs-uri}/visualization-graph[`VisualizationGraph`] directly.
13-
* xref:integration.adoc[] for importing data from a Pandas DataFrame or Neo4j GDS projection.
13+
* xref:integration/index.adoc[] for importing data from a Pandas DataFrame or Neo4j GDS projection.
1414
1515
== Setting node captions
1616

docs/antora/modules/ROOT/pages/getting-started.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,6 @@ Now that we have covered the basics of creating and rendering a visualization gr
8686
Here are some suggestions for what to do next:
8787

8888
* Browse the link:{tutorials-docs-uri}[notebook examples] for more examples and use cases
89-
* Learn about the xref:integration.adoc[integrations] with other libraries such as Neo4j GDS and Pandas
89+
* Learn about the xref:integration/index.adoc[integrations] with other libraries such as Neo4j GDS and Pandas
9090
* Check out the xref:rendering.adoc[rendering options] and convenience methods of `VisualizationGraph`
9191
* Read about our link:{api-docs-uri}/[API reference]
Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
= Introduction
22

3-
This is the documentation for the `neo4j-viz` Python library by Neo4j.
4-
The library allows you to visualize graph data interactively in Python using a simple API.
3+
The Python Graph Visualization library allows you to visualize graph data interactively in Python.
54

6-
The library wraps the link:https://neo4j.com/docs/nvl/current/[Neo4j Visualization JavaScript library (NVL)], and provides additional features for working with graph data in Python.
7-
Notably, there are convenience methods for importing data from source such as link:https://pandas.pydata.org/[Pandas DataFrames], link:https://neo4j.com/docs/graph-data-science/current/[Neo4j Graph Data Science], link:https://neo4j.com/docs/python-manual/current/[Neo4j Database], and link:https://docs.snowflake.com/[Snowflake tables].
5+
The library wraps the JavaScript-based link:https://neo4j.com/docs/nvl/current/[Neo4j Visualization Library (NVL)] and adds convenience methods to import data from sources such as:
6+
7+
* xref:integration/pandas.adoc[]
8+
* xref:integration/gds.adoc[]
9+
* xref:integration/neo4j.adoc[]
10+
* xref:integration/snowflake.adoc[]
811
912
The source code is available on link:https://github.com/neo4j/python-graph-visualization[GitHub].
1013
If you have a suggestion on how we can improve the library or want to report a problem, you can create a link:https://github.com/neo4j/python-graph-visualization/issues/new[new issue].

docs/antora/modules/ROOT/pages/installation.adoc

Lines changed: 6 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Installation
22

3-
To install the latest version of the library, run:
3+
You can install the latest version of the library with `pip`:
44

55
[source, console]
66
----
@@ -9,47 +9,16 @@ pip install neo4j-viz
99

1010
== Optional dependencies
1111

12-
In addition, there are a few optional dependencies that you can install to enable additional features of the library.
12+
There are a few optional dependencies that you can install to enable additional features of the library.
1313

14-
=== Pandas DataFrames `from_dfs` importer
14+
=== Integration with external sources
1515

16-
To install the additional dependencies required for the link:{api-docs-uri}/from_pandas[`from_dfs`] importer you can run:
17-
18-
[source, console]
19-
----
20-
pip install neo4j-viz[pandas]
21-
----
22-
23-
=== Neo4j `from_neo4j` importer
24-
25-
To install the additional dependencies required for the link:{api-docs-uri}/from_neo4j[`from_neo4j`] importer you can run:
26-
27-
[source, console]
28-
----
29-
pip install neo4j-viz[neo4j]
30-
----
31-
32-
=== Neo4j Graph Data Science `from_gds` importer
33-
34-
To install the additional dependencies required for the link:{api-docs-uri}/from_gds[`from_gds`] importer you can run:
35-
36-
[source, console]
37-
----
38-
pip install neo4j-viz[gds]
39-
----
40-
41-
=== Neo4j Graph Data Science `from_snowflake` importer
42-
43-
To install the additional dependencies required for the link:{api-docs-uri}/from_snowflake[`from_snowflake`] importer you can run:
44-
45-
[source, console]
46-
----
47-
pip install neo4j-viz[snowflake]
48-
----
16+
The library can import data directly from xref:integration/index.adoc[external sources].
17+
Each integration page includes installation instructions for the needed dependencies.
4918

5019
=== Notebook tutorials
5120

52-
To install all the additional dependencies required for the link:{tutorials-docs-uri}[notebook examples] you can run:
21+
You need to install some additional dependencies to run the link:{tutorials-docs-uri}[Jupyter notebook tutorials]:
5322

5423
[source, console]
5524
----

0 commit comments

Comments
 (0)