From 3237237c9b34df46d0c781012024b992bf7a493b Mon Sep 17 00:00:00 2001 From: Adam Schill Collberg Date: Thu, 23 Jan 2025 11:00:58 +0100 Subject: [PATCH] Improve documentation structure --- docs/source/{ => api-reference}/from_gds.rst | 0 docs/source/{ => api-reference}/from_pandas.rst | 0 docs/source/{ => api-reference}/graph.rst | 0 docs/source/api-reference/index.rst | 17 +++++++++++++++++ .../{ => api-reference}/render_options.rst | 0 docs/source/getting-started.rst | 2 ++ docs/source/index.rst | 10 ++++++---- docs/source/installation.rst | 2 ++ docs/source/tutorials/index.rst | 17 +++++++++++++++++ 9 files changed, 44 insertions(+), 4 deletions(-) rename docs/source/{ => api-reference}/from_gds.rst (100%) rename docs/source/{ => api-reference}/from_pandas.rst (100%) rename docs/source/{ => api-reference}/graph.rst (100%) create mode 100644 docs/source/api-reference/index.rst rename docs/source/{ => api-reference}/render_options.rst (100%) create mode 100644 docs/source/getting-started.rst create mode 100644 docs/source/installation.rst create mode 100644 docs/source/tutorials/index.rst diff --git a/docs/source/from_gds.rst b/docs/source/api-reference/from_gds.rst similarity index 100% rename from docs/source/from_gds.rst rename to docs/source/api-reference/from_gds.rst diff --git a/docs/source/from_pandas.rst b/docs/source/api-reference/from_pandas.rst similarity index 100% rename from docs/source/from_pandas.rst rename to docs/source/api-reference/from_pandas.rst diff --git a/docs/source/graph.rst b/docs/source/api-reference/graph.rst similarity index 100% rename from docs/source/graph.rst rename to docs/source/api-reference/graph.rst diff --git a/docs/source/api-reference/index.rst b/docs/source/api-reference/index.rst new file mode 100644 index 00000000..5b0b583b --- /dev/null +++ b/docs/source/api-reference/index.rst @@ -0,0 +1,17 @@ +.. Graph Visualization for Python by Neo4j documentation master file, created by + sphinx-quickstart on Fri Jan 10 13:54:11 2025. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +API Reference +===================================================== + +This is an API reference for the `neo4j-viz` library. + + +.. toctree:: + :glob: + :maxdepth: 1 + :caption: Contents: + + * diff --git a/docs/source/render_options.rst b/docs/source/api-reference/render_options.rst similarity index 100% rename from docs/source/render_options.rst rename to docs/source/api-reference/render_options.rst diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst new file mode 100644 index 00000000..55886fc2 --- /dev/null +++ b/docs/source/getting-started.rst @@ -0,0 +1,2 @@ +Getting Started +--------------- diff --git a/docs/source/index.rst b/docs/source/index.rst index dea79647..34528bcc 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,10 +3,10 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Graph Visualization for Python documentation +Graph Visualization for Python by Neo4j documentation ===================================================== -This API reference manual lists all available endpoints in the `neo4j_viz` `package `_. +This is the documentation for the `neo4j_viz` Python library by Neo4j for creating interactive graph visualizations. .. toctree:: @@ -14,5 +14,7 @@ This API reference manual lists all available endpoints in the `neo4j_viz` `pack :maxdepth: 1 :caption: Contents: - * - tutorials/* + installation.rst + getting-started.rst + api-reference/index.rst + tutorials/index.rst diff --git a/docs/source/installation.rst b/docs/source/installation.rst new file mode 100644 index 00000000..14b533e3 --- /dev/null +++ b/docs/source/installation.rst @@ -0,0 +1,2 @@ +Installation +------------ diff --git a/docs/source/tutorials/index.rst b/docs/source/tutorials/index.rst new file mode 100644 index 00000000..692647fa --- /dev/null +++ b/docs/source/tutorials/index.rst @@ -0,0 +1,17 @@ +.. Graph Visualization for Python by Neo4j documentation master file, created by + sphinx-quickstart on Fri Jan 10 13:54:11 2025. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Tutorials +===================================================== + +This chapter contains Jupyter notebook tutorials for the `neo4j_viz` package. + + +.. toctree:: + :glob: + :maxdepth: 1 + :caption: Contents: + + *