Documentation should be available on GitHub pages:

• add GitHub action workflow to generate documentation
• step1 : generate documentation with sphinx (waiting #3 )
• step2 : deploy generated documentation on GitHub pages

Need

Today, there is two hardcoded columns in sql_templates/generate_routeProcedures.sh l.112-122 : $SCHEMA.ways.cost_m_', profile_name and $SCHEMA.ways.cost_s_', profile_name.

To delete them, we need to change the parameters of the functions by adding the real name of the cost columns for distance, duration and the cost of the computed road.

Tasks

• Be sure of the IO
• Code it
• Update r2gg
• Update road2

Create a new .github/workflows/docker-publish.yml to add docker publication to CI.

Use https://github.com/marketplace/actions/build-and-push-docker-images to build and push docker image

• define dockerhub user that will be used for the publication
• add secrets in GitHub settings to store docker hub user and password
• use docker GitHub Actions to build and push

Create a new .github/workflows/tests.yml to add tests to CI.

Tests to add:

• performance test for route procedure

PgRouting is now available in a 3.5 version. But we are on 3.1.

Add test for isochrone procedure.

Content and langage for tests to be defined. route tests are written in R but we can use a different langage.

Add documentation with sphynx:

• create a root directory documentation
• add conf.py to define sphynx option
• TO BE DISCUSSED : move all .md documentation files to the `documentation directory
• create landing page documentation/index.md

SQL procedures are duplicated in : sql_templates/generate_<procedure>.sh and sql/<procedure>.sh

It will be better to have only templated .sql files.

Should we update repository name to indicate road2 ?

For example : road2-pgrouting-procedures