Skip to content

Commit 6edb759

Browse files
committed
Update of TOC and index
1 parent f9a582e commit 6edb759

File tree

2 files changed

+42
-42
lines changed

2 files changed

+42
-42
lines changed

docs/ricgraph_index_documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ __R__
150150
- [Research outputs connected to persons](../docs/ricgraph_details.md#research-outputs-connected-to-persons)
151151
- [Research question “What are the research results of person A” ](../docs/ricgraph_explorer.md#research-question-what-are-the-research-results-of-person-a-)
152152
- [Restore a Neo4j Community Edition database dump of Ricgraph in Neo4j Community Edition](../docs/ricgraph_install_configure.md#restore-a-neo4j-community-edition-database-dump-of-ricgraph-in-neo4j-community-edition)
153-
- [Restore a Neo4j Desktop database dump of Ricgraph in Neo4j Community Edition](../docs/ricgraph_install_configure.md#restore-a-neo4j-desktop-database-dump-of-ricgraph-in-neo4j-community-edition)
154153
- [Restore a Neo4j Desktop database dump of Ricgraph in Neo4j Community Edition](../docs/ricgraph_as_server.md#restore-a-neo4j-desktop-database-dump-of-ricgraph-in-neo4j-community-edition)
154+
- [Restore a Neo4j Desktop database dump of Ricgraph in Neo4j Community Edition](../docs/ricgraph_install_configure.md#restore-a-neo4j-desktop-database-dump-of-ricgraph-in-neo4j-community-edition)
155155
- [Restore a Neo4j Desktop database dump of Ricgraph in Neo4j Desktop](../docs/ricgraph_install_configure.md#restore-a-neo4j-desktop-database-dump-of-ricgraph-in-neo4j-desktop)
156156
- [Results page](../docs/ricgraph_explorer.md#results-page)
157157
- [Ricgraph - Research in context graph ](../README.md#ricgraph---research-in-context-graph-)

docs/ricgraph_toc_documentation.md

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,37 @@ This table of contents has been generated automatically.
1616
- [Read this in case you would like to extend Ricgraph](../README.md#read-this-in-case-you-would-like-to-extend-ricgraph)
1717
- [Ricgraph website](../README.md#ricgraph-website)
1818
- [Contact](../README.md#contact)
19+
- [Ricgraph as a server on Linux](../docs/ricgraph_as_server.md#ricgraph-as-a-server-on-linux)
20+
- [Check the requirements](../docs/ricgraph_as_server.md#check-the-requirements)
21+
- [Install and start Neo4j Community Edition](../docs/ricgraph_as_server.md#install-and-start-neo4j-community-edition)
22+
- [Post-install steps Neo4j Community Edition](../docs/ricgraph_as_server.md#post-install-steps-neo4j-community-edition)
23+
- [Install and start Memgraph](../docs/ricgraph_as_server.md#install-and-start-memgraph)
24+
- [Create a ricgraph user and group](../docs/ricgraph_as_server.md#create-a-ricgraph-user-and-group)
25+
- [Create a Python virtual environment and install Ricgraph in it](../docs/ricgraph_as_server.md#create-a-python-virtual-environment-and-install-ricgraph-in-it)
26+
- [Run Ricgraph scripts from the command line or as a cronjob](../docs/ricgraph_as_server.md#run-ricgraph-scripts-from-the-command-line-or-as-a-cronjob)
27+
- [In case you have installed Ricgraph as a server](../docs/ricgraph_as_server.md#in-case-you-have-installed-ricgraph-as-a-server)
28+
- [In case you have installed Ricgraph for a single user](../docs/ricgraph_as_server.md#in-case-you-have-installed-ricgraph-for-a-single-user)
29+
- [Using the Makefile](../docs/ricgraph_as_server.md#using-the-makefile)
30+
- [Use a service unit file to run Ricgraph Explorer and the Ricgraph REST API](../docs/ricgraph_as_server.md#use-a-service-unit-file-to-run-ricgraph-explorer-and-the-ricgraph-rest-api)
31+
- [Use Apache, WSGI, and ASGI to make Ricgraph Explorer and the Ricgraph REST API accessible from outside your virtual machine](../docs/ricgraph_as_server.md#use-apache-wsgi-and-asgi-to-make-ricgraph-explorer-and-the-ricgraph-rest-api-accessible-from-outside-your-virtual-machine)
32+
- [Introduction Apache webserver](../docs/ricgraph_as_server.md#introduction-apache-webserver)
33+
- [Installation Apache](../docs/ricgraph_as_server.md#installation-apache)
34+
- [Post-install steps Apache](../docs/ricgraph_as_server.md#post-install-steps-apache)
35+
- [Use Nginx, WSGI, and ASGI to make Ricgraph Explorer and the Ricgraph REST API accessible from outside your virtual machine](../docs/ricgraph_as_server.md#use-nginx-wsgi-and-asgi-to-make-ricgraph-explorer-and-the-ricgraph-rest-api-accessible-from-outside-your-virtual-machine)
36+
- [Introduction Nginx webserver](../docs/ricgraph_as_server.md#introduction-nginx-webserver)
37+
- [Installation Nginx](../docs/ricgraph_as_server.md#installation-nginx)
38+
- [Post-install steps Nginx](../docs/ricgraph_as_server.md#post-install-steps-nginx)
39+
- [Restore a Neo4j Desktop database dump of Ricgraph in Neo4j Community Edition](../docs/ricgraph_as_server.md#restore-a-neo4j-desktop-database-dump-of-ricgraph-in-neo4j-community-edition)
40+
- [How to install Ricgraph and Ricgraph Explorer on SURF Research Cloud](../docs/ricgraph_as_server.md#how-to-install-ricgraph-and-ricgraph-explorer-on-surf-research-cloud)
41+
- [How to solve an AttributeError: Neo4jDriver object has no attribute executequery](../docs/ricgraph_as_server.md#how-to-solve-an-attributeerror-neo4jdriver-object-has-no-attribute-executequery)
42+
- [Ricgraph comparison](../docs/ricgraph_comparison.md#ricgraph-comparison)
43+
- [General overview](../docs/ricgraph_comparison.md#general-overview)
44+
- [Extendability](../docs/ricgraph_comparison.md#extendability)
45+
- [Ricgraph in a container](../docs/ricgraph_containerized.md#ricgraph-in-a-container)
46+
- [Notes on the Ricgraph Podman container](../docs/ricgraph_containerized.md#notes-on-the-ricgraph-podman-container)
47+
- [Install Podman](../docs/ricgraph_containerized.md#install-podman)
48+
- [Install and run the Ricgraph Podman container](../docs/ricgraph_containerized.md#install-and-run-the-ricgraph-podman-container)
49+
- [Advanced use of the Ricgraph Podman container](../docs/ricgraph_containerized.md#advanced-use-of-the-ricgraph-podman-container)
1950
- [Implementation details](../docs/ricgraph_details.md#implementation-details)
2051
- [Person identifiers](../docs/ricgraph_details.md#person-identifiers)
2152
- [Person-root node in Ricgraph](../docs/ricgraph_details.md#person-root-node-in-ricgraph)
@@ -57,6 +88,7 @@ This table of contents has been generated automatically.
5788
- [Harvest of software from the Research Software Directory (harvest_rsd_to_ricgraph.py)](../docs/ricgraph_harvest_scripts.md#harvest-of-software-from-the-research-software-directory-harvest_rsd_to_ricgraphpy)
5889
- [Order of running the harvest scripts](../docs/ricgraph_harvest_scripts.md#order-of-running-the-harvest-scripts)
5990
- [How to make your own harvesting scripts](../docs/ricgraph_harvest_scripts.md#how-to-make-your-own-harvesting-scripts)
91+
- [Index Ricgraph documentation](../docs/ricgraph_index_documentation.md#index-ricgraph-documentation)
6092
- [Install and configure Ricgraph](../docs/ricgraph_install_configure.md#install-and-configure-ricgraph)
6193
- [Ricgraph Makefile](../docs/ricgraph_install_configure.md#ricgraph-makefile)
6294
- [Installation instructions for a single user](../docs/ricgraph_install_configure.md#installation-instructions-for-a-single-user)
@@ -119,39 +151,6 @@ This table of contents has been generated automatically.
119151
- [Installation of the Ricgraph REST API](../docs/ricgraph_restapi.md#installation-of-the-ricgraph-rest-api)
120152
- [Use of the Ricgraph REST API](../docs/ricgraph_restapi.md#use-of-the-ricgraph-rest-api)
121153
- [Generate the Ricgraph REST API documentation page](../docs/ricgraph_restapi.md#generate-the-ricgraph-rest-api-documentation-page)
122-
- [Ricgraph script writing](../docs/ricgraph_script_writing.md#ricgraph-script-writing)
123-
- [How to make your own harvesting scripts](../docs/ricgraph_script_writing.md#how-to-make-your-own-harvesting-scripts)
124-
- [General program structure of a Python script using Ricgraph](../docs/ricgraph_script_writing.md#general-program-structure-of-a-python-script-using-ricgraph)
125-
- [Structure of a Python script that is harvesting data](../docs/ricgraph_script_writing.md#structure-of-a-python-script-that-is-harvesting-data)
126-
- [Function calls for inserting nodes](../docs/ricgraph_script_writing.md#function-calls-for-inserting-nodes)
127-
- [Function call for unifying personal identifiers](../docs/ricgraph_script_writing.md#function-call-for-unifying-personal-identifiers)
128-
- [Function calls to create, read (find), update and delete (CRUD) nodes](../docs/ricgraph_script_writing.md#function-calls-to-create-read-find-update-and-delete-crud-nodes)
129-
- [Function calls to get neighbors of nodes](../docs/ricgraph_script_writing.md#function-calls-to-get-neighbors-of-nodes)
130-
- [Index Ricgraph documentation](../docs/ricgraph_index_documentation.md#index-ricgraph-documentation)
131-
- [Table of contents Ricgraph documentation](../docs/ricgraph_toc_documentation.md#table-of-contents-ricgraph-documentation)
132-
- [Ricgraph as a server on Linux](../docs/ricgraph_as_server.md#ricgraph-as-a-server-on-linux)
133-
- [Check the requirements](../docs/ricgraph_as_server.md#check-the-requirements)
134-
- [Install and start Neo4j Community Edition](../docs/ricgraph_as_server.md#install-and-start-neo4j-community-edition)
135-
- [Post-install steps Neo4j Community Edition](../docs/ricgraph_as_server.md#post-install-steps-neo4j-community-edition)
136-
- [Install and start Memgraph](../docs/ricgraph_as_server.md#install-and-start-memgraph)
137-
- [Create a ricgraph user and group](../docs/ricgraph_as_server.md#create-a-ricgraph-user-and-group)
138-
- [Create a Python virtual environment and install Ricgraph in it](../docs/ricgraph_as_server.md#create-a-python-virtual-environment-and-install-ricgraph-in-it)
139-
- [Run Ricgraph scripts from the command line or as a cronjob](../docs/ricgraph_as_server.md#run-ricgraph-scripts-from-the-command-line-or-as-a-cronjob)
140-
- [In case you have installed Ricgraph as a server](../docs/ricgraph_as_server.md#in-case-you-have-installed-ricgraph-as-a-server)
141-
- [In case you have installed Ricgraph for a single user](../docs/ricgraph_as_server.md#in-case-you-have-installed-ricgraph-for-a-single-user)
142-
- [Using the Makefile](../docs/ricgraph_as_server.md#using-the-makefile)
143-
- [Use a service unit file to run Ricgraph Explorer and the Ricgraph REST API](../docs/ricgraph_as_server.md#use-a-service-unit-file-to-run-ricgraph-explorer-and-the-ricgraph-rest-api)
144-
- [Use Apache, WSGI, and ASGI to make Ricgraph Explorer and the Ricgraph REST API accessible from outside your virtual machine](../docs/ricgraph_as_server.md#use-apache-wsgi-and-asgi-to-make-ricgraph-explorer-and-the-ricgraph-rest-api-accessible-from-outside-your-virtual-machine)
145-
- [Introduction Apache webserver](../docs/ricgraph_as_server.md#introduction-apache-webserver)
146-
- [Installation Apache](../docs/ricgraph_as_server.md#installation-apache)
147-
- [Post-install steps Apache](../docs/ricgraph_as_server.md#post-install-steps-apache)
148-
- [Use Nginx, WSGI, and ASGI to make Ricgraph Explorer and the Ricgraph REST API accessible from outside your virtual machine](../docs/ricgraph_as_server.md#use-nginx-wsgi-and-asgi-to-make-ricgraph-explorer-and-the-ricgraph-rest-api-accessible-from-outside-your-virtual-machine)
149-
- [Introduction Nginx webserver](../docs/ricgraph_as_server.md#introduction-nginx-webserver)
150-
- [Installation Nginx](../docs/ricgraph_as_server.md#installation-nginx)
151-
- [Post-install steps Nginx](../docs/ricgraph_as_server.md#post-install-steps-nginx)
152-
- [Restore a Neo4j Desktop database dump of Ricgraph in Neo4j Community Edition](../docs/ricgraph_as_server.md#restore-a-neo4j-desktop-database-dump-of-ricgraph-in-neo4j-community-edition)
153-
- [How to install Ricgraph and Ricgraph Explorer on SURF Research Cloud](../docs/ricgraph_as_server.md#how-to-install-ricgraph-and-ricgraph-explorer-on-surf-research-cloud)
154-
- [How to solve an AttributeError: Neo4jDriver object has no attribute executequery](../docs/ricgraph_as_server.md#how-to-solve-an-attributeerror-neo4jdriver-object-has-no-attribute-executequery)
155154
- [Ricgraph - Research in context graph REST API](../docs/ricgraph_restapi_gendoc.md#ricgraph---research-in-context-graph-rest-api)
156155
- [How to use](../docs/ricgraph_restapi_gendoc.md#how-to-use)
157156
- [Technicalities](../docs/ricgraph_restapi_gendoc.md#technicalities)
@@ -173,11 +172,12 @@ This table of contents has been generated automatically.
173172
- [GET /get_all_personroot_nodes](../docs/ricgraph_restapi_gendoc.md#get-get_all_personroot_nodes)
174173
- [GET /get_all_neighbor_nodes](../docs/ricgraph_restapi_gendoc.md#get-get_all_neighbor_nodes)
175174
- [GET /get_ricgraph_list](../docs/ricgraph_restapi_gendoc.md#get-get_ricgraph_list)
176-
- [Ricgraph comparison](../docs/ricgraph_comparison.md#ricgraph-comparison)
177-
- [General overview](../docs/ricgraph_comparison.md#general-overview)
178-
- [Extendability](../docs/ricgraph_comparison.md#extendability)
179-
- [Ricgraph in a container](../docs/ricgraph_containerized.md#ricgraph-in-a-container)
180-
- [Notes on the Ricgraph Podman container](../docs/ricgraph_containerized.md#notes-on-the-ricgraph-podman-container)
181-
- [Install Podman](../docs/ricgraph_containerized.md#install-podman)
182-
- [Install and run the Ricgraph Podman container](../docs/ricgraph_containerized.md#install-and-run-the-ricgraph-podman-container)
183-
- [Advanced use of the Ricgraph Podman container](../docs/ricgraph_containerized.md#advanced-use-of-the-ricgraph-podman-container)
175+
- [Ricgraph script writing](../docs/ricgraph_script_writing.md#ricgraph-script-writing)
176+
- [How to make your own harvesting scripts](../docs/ricgraph_script_writing.md#how-to-make-your-own-harvesting-scripts)
177+
- [General program structure of a Python script using Ricgraph](../docs/ricgraph_script_writing.md#general-program-structure-of-a-python-script-using-ricgraph)
178+
- [Structure of a Python script that is harvesting data](../docs/ricgraph_script_writing.md#structure-of-a-python-script-that-is-harvesting-data)
179+
- [Function calls for inserting nodes](../docs/ricgraph_script_writing.md#function-calls-for-inserting-nodes)
180+
- [Function call for unifying personal identifiers](../docs/ricgraph_script_writing.md#function-call-for-unifying-personal-identifiers)
181+
- [Function calls to create, read (find), update and delete (CRUD) nodes](../docs/ricgraph_script_writing.md#function-calls-to-create-read-find-update-and-delete-crud-nodes)
182+
- [Function calls to get neighbors of nodes](../docs/ricgraph_script_writing.md#function-calls-to-get-neighbors-of-nodes)
183+
- [Table of contents Ricgraph documentation](../docs/ricgraph_toc_documentation.md#table-of-contents-ricgraph-documentation)

0 commit comments

Comments
 (0)