Merge pull request #86 from pgRouting/new_documentation

Documentation - first version

Author: MarPetra

builddoc.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+rm -fR site
+mkdocs gh-deploy --clean
+rm -fR site

docs/functions/pgr_astar.md

@@ -0,0 +1,15 @@
+# pgr_astar
+
+- Uses BBOX of the QGIS canvas to limit the resulting path(s)
+
+- Buttons:
+  - Preview: Draws in the canvas the resulting path
+  - Clear Preview: Removes from the canvas objects generated with Preview
+  - Export: Creates a one row per edge line geometry layer
+  - Export Merged: Creates a one row per path multiline geometry layer. As many rows as needed.
+- Layer name:
+```
+(< M >< U|D >) astar: < source_id >  to < target_id>  BBOX(< bbox >)
+```
+
+![pgr_astar01](../img/pgr_astar01.png)

docs/functions/pgr_bdastar.md

@@ -0,0 +1,15 @@
+# pgr_bdastar
+
+- Uses BBOX of the QGIS canvas to limit the resulting path(s)
+
+- Buttons:
+  - Preview: Draws in the canvas the resulting path
+  - Clear Preview: Removes from the canvas objects generated with Preview
+  - Export: Creates a one row per edge line geometry layer
+  - Export Merged: Creates a one row per path multiline geometry layer. As many rows as needed.
+- Layer name:
+```
+(< M >< U|D >) bdAstar: < source_id >  to < target_id>  BBOX(< bbox >)
+```
+
+![pgr_astar01](../img/pgr_astar01.png)

docs/functions/pgr_bddijkstra.md

@@ -0,0 +1,15 @@
+# pgr_bddijkstra
+
+- Uses BBOX of the QGIS canvas to limit the resulting path(s)
+
+- Buttons:
+  - Preview: Draws in the canvas the resulting path
+  - Clear Preview: Removes from the canvas objects generated with Preview
+  - Export: Creates a one row per edge line geometry layer
+  - Export Merged: Creates a one row per path multiline geometry layer. As many rows as needed.
+- Layer name:
+```
+(< M >< U|D >) bdDijkstra: < source_id >  to < target_id>  BBOX(< bbox >)
+```
+
+![pgr_dijkstra01](../img/pgr_dijkstra01.png)

docs/functions/pgr_dijkstra.md

@@ -0,0 +1,15 @@
+# pgr_dijkstra
+
+- Uses BBOX of the QGIS canvas to limit the resulting path(s)
+
+- Buttons:
+  - Preview: Draws in the canvas the resulting path
+  - Clear Preview: Removes from the canvas objects generated with Preview
+  - Export: Creates a one row per edge line geometry layer
+  - Export Merged: Creates a one row per path multiline geometry layer. As many rows as needed.
+- Layer name:
+```
+(< M >< U|D >) dijkstra: < source_ids > to < target_ids> BBOX(< bbox >)
+```
+
+![pgr_dijkstra01](../img/pgr_dijkstra01.png)

docs/img/buttons.png

@@ -0,0 +1,54 @@
+# pgRoutingLayer documentation
+
+Welcome to pgRoutingLayer documentation.
+
+
+## About pgRoutingLayer
+
+pgRoutingLayer is a plugin for QGIS that serves as a GUI for pgRouting - a popular routing solution for PostGIS databases.
+
+## What this plugin currently does
+
+### Introduction
+
+- [Layer Naming Convention](intro/layer_naming_convention.md)
+- [Main buttons](intro/buttons.md)
+
+### Functions
+
+PgRoutingLayer currently supports the following functions:
+
+- [Dijkstra](functions/pgr_dijkstra.md)
+- [Astar](functions/pgr_astar.md)
+- [bdDijkstra](functions/pgr_bddijkstra.md)
+- [bdAstar](functions/pgr_bdastar.md)
+- KSP
+- Trsp_vertex
+- Trsp_edge
+- Trsp_via_vertices
+- Trsp_via_edges
+- DrivingDistance
+- Alphashape
+
+Please check the pgRouting documentation for detailed descriptons: http://docs.pgrouting.org
+
+## Installation
+
+This plugin can be installed using the QGIS Plugin Manager. You will have to enable "experimental" plugins.
+
+### Dependencies
+
+- This plugin runs only with QGIS 3.x and Python 3.
+- pgRouting v2.x up and running to use this plugin.
+- Additionally, QGIS needs python-psycopg2 installed to be able to connect to the database.
+
+## Links
+
+- project home and bug tracker: https://github.com/pgrouting/pgRoutingLayer
+- plugin repository: http://plugins.qgis.org/plugins
+- pgRouting project: https://pgrouting.org
+
+
+## License
+
+This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

docs/img/pgr_astar01.png

@@ -0,0 +1,30 @@
+## The Buttons
+There are 4 buttons for controlling how to render the pgRouting query:
+
+![buttons](../img/buttons.png)
+
+
+### Preview
+Draws in the canvas the resulting path.
+
+Creates a temporary lines on the canvas. No additional information is shown, except for pgr_dijkstraCost where an annotation is also created.
+
+
+### Clear Preview
+Removes from the canvas objects generated with Preview
+
+When Clear Preview is called the generated temporary lines and annotation are deleted from the canvas. When the QGIS project is saved when there are visible annotations:
+
+- Those annotations will be saved as part of the project
+- Can be cleared with Clear Preview button, but the project needs to be saved again. On reopening a project that has annotation:
+- The annotations will be shown, but won't be cleared using the Clear Preview button, they are not under the pgRoutingLayer GUI control
+
+
+### Export
+Creates a one row per edge line geometry layer
+
+
+### Export Merged
+Creates a one row per path multi-line geometry layer.
+
+Only one row is generated. Not all functions results can be merged, when that is the case then the button is dimmed.