Merge pull request #165 from krashish8/ashish-2021

vrp_vroom GSoC-2021 Bonding Period

.editorconfig

@@ -9,7 +9,7 @@ indent_size = 4
 indent_style = space
 charset = utf-8
 end_of_line = lf
-insert_final_newline = false
+insert_final_newline = true
 trim_trailing_whitespace = true
 
 # C++ files want tab indentation
@@ -52,4 +52,4 @@ indent_style = space
 # RST files
 [*.html]
 indent_size = 2
-indent_style = space
+indent_style = space

configuration.conf

@@ -27,3 +27,4 @@ viewRoute           | N | Y | N
 simulation          | N | Y | N
 optimizers          | Y | N | N
 initialsol          | Y | N | N
+vroom               | N | N | Y

doc/conf.py.in

@@ -171,8 +171,8 @@ html_last_updated_fmt = '%b %d, %Y'
 
 # Custom sidebar templates, maps document names to template names.
 html_sidebars = {
-	# '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'],
-	# 'using/windows': ['windowssidebar.html', 'searchbox.html'],
+    # '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'],
+    # 'using/windows': ['windowssidebar.html', 'searchbox.html'],
 }
 
 # Additional templates that should be rendered to pages, maps page names to
@@ -317,6 +317,8 @@ linkcheck_ignore = [
     r"https://gis.stackexchange.com/",
     "https://vrp.pgrouting.org/v0/en/pgr-category.html",
     "https://vrp.pgrouting.org/latest/en/pgr-category.html",
+    "https://vrp.pgrouting.org/v0/en/vrp_vroom.html",
+    "https://vrp.pgrouting.org/latest/en/vrp_vroom.html",
 
     # (see: https://github.com/sphinx-doc/sphinx/issues/7388)
     r"https://github.com/pgRouting/vrprouting/",    # limit only vrprouting

doc/general/experimental.rst

@@ -52,6 +52,13 @@ Experimental Functions
 
   pgr-category
 
+:doc:`pgr-category`
+
+.. toctree::
+  :maxdepth: 1
+
+  vrp_vroom
+
 .. rubric:: See Also
 
 * :doc:`proposed`

doc/vroom/CMakeLists.txt

@@ -0,0 +1,12 @@
+
+SET(LOCAL_FILES
+    vrp_vroom.rst
+    )
+
+foreach (f ${LOCAL_FILES})
+    configure_file(${f} "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}")
+    list(APPEND LOCAL_DOC_FILES  ${PGR_DOCUMENTATION_SOURCE_DIR}/${f})
+endforeach()
+
+set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE)
+set(PROJECT_IMG_FILES ${PROJECT_IMG_FILES} PARENT_SCOPE)

docqueries/vroom/CMakeLists.txt

@@ -0,0 +1,11 @@
+# Do not use extensions
+SET(LOCAL_FILES
+    doc-vrp_vroom
+    )
+
+foreach (f ${LOCAL_FILES})
+    configure_file("${f}.result" "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries")
+    list(APPEND LOCAL_DOC_FILES  "${PGR_DOCUMENTATION_SOURCE_DIR}/${f}.queries")
+endforeach()
+
+set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE)

docqueries/vroom/doc-vrp_vroom.result

@@ -0,0 +1,6 @@
+BEGIN;
+BEGIN
+SET client_min_messages TO NOTICE;
+SET
+ROLLBACK;
+ROLLBACK

docqueries/vroom/test.conf

@@ -0,0 +1,17 @@
+#!/usr/bin/perl -w
+
+%main::tests = (
+    'any' => {
+        'comment' => 'VRP with VROOM tests.',
+        'data' => [ ],
+        'tests' => [qw(
+            doc-vrp_vroom
+            )],
+        'documentation' => [qw(
+            doc-vrp_vroom
+            )]
+    },
+
+);
+
+1;