Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@

### vrpRouting 0.4.2 Release Notes

No changes yet.
**Documentation queries**

* Renamed to extension `.pg`
* Removed `doc-` and `doc-vrp_` suffixes on file names

### vrpRouting 0.4.1 Release Notes

Expand Down
5 changes: 4 additions & 1 deletion doc/general/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ vrpRouting 0.4
vrpRouting 0.4.2 Release Notes
-------------------------------------------------------------------------------

No changes yet.
.. rubric:: Documentation queries

* Renamed to extension `.pg`
* Removed `doc-` and `doc-vrp_` suffixes on file names

vrpRouting 0.4.1 Release Notes
-------------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion doc/general/sampledata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Modified VROOM Data
The tables created using the above VROOM Data are modified for the VROOM functions
with timestamps/interval, as:

.. literalinclude:: ../../docqueries/vroom/doc-vrp_vroom.test.sql
.. literalinclude:: ../../docqueries/vroom/vroom.pg
:start-after: -- q0
:end-before: -- q1

Expand Down
2 changes: 1 addition & 1 deletion doc/or_tools/vrp_bin_packing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Where:
Example
-------------------------------------------------------------------------------

.. literalinclude:: doc-vrp_bin_packing.queries
.. literalinclude:: bin_packing.queries
:start-after: -- example_start
:end-before: -- example_end

Expand Down
2 changes: 1 addition & 1 deletion doc/or_tools/vrp_knapsack.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Where:
Example
-------------------------------------------------------------------------------

.. literalinclude:: doc-vrp_knapsack.queries
.. literalinclude:: knapsack.queries
:start-after: -- example_start
:end-before: -- example_end

Expand Down
2 changes: 1 addition & 1 deletion doc/or_tools/vrp_multiple_knapsack.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Result Columns
Example
-------------------------------------------------------------------------------

.. literalinclude:: doc-vrp_multiple_knapsack.queries
.. literalinclude:: multiple_knapsack.queries
:start-after: -- example_start
:end-before: -- example_end

Expand Down
2 changes: 1 addition & 1 deletion doc/pgr_pickDeliver/vrp_oneDepot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Result Columns
Example
-------------------------------------------------------------------------------

.. literalinclude:: doc-oneDepot.queries
.. literalinclude:: oneDepot.queries

.. rubric:: Data

Expand Down
2 changes: 1 addition & 1 deletion doc/pgr_pickDeliver/vrp_pgr_pickDeliver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ Example

This example use the following data:

.. literalinclude:: doc-pgr_pickDeliver.queries
.. literalinclude:: pgr_pickDeliver.queries
:start-after: --q2
:end-before: --q3

Expand Down
2 changes: 1 addition & 1 deletion doc/pgr_pickDeliver/vrp_pgr_pickDeliverEuclidean.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ Example
This example use the following data:


.. literalinclude:: ./doc-pgr_pickDeliverEuclidean.queries
.. literalinclude:: ./pgr_pickDeliverEuclidean.queries
:start-after: --q1
:end-before: --q2

Expand Down
2 changes: 1 addition & 1 deletion doc/version/vrp_full_version.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Signatures

:Example: Get the version installed for this documentation.

.. literalinclude:: doc-full_version.queries
.. literalinclude:: full_version.queries
:start-after: -- q1
:end-before: -- q2

Expand Down
2 changes: 1 addition & 1 deletion doc/version/vrp_version.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Signatures

:Example: vrpRouting Version for this documentatoin

.. literalinclude:: doc-version.queries
.. literalinclude:: version.queries
:start-after: -- q1
:end-before: -- q2

Expand Down
4 changes: 2 additions & 2 deletions doc/vroom/vrp_vroom.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Optional parameters are `named parameters` and have a default value.
**Example**: This example is based on the modified VROOM Data of the :doc:`sampledata` network.
The modification in the tables is mentioned at the end of the :doc:`sampledata`.

.. literalinclude:: doc-vrp_vroom.queries
.. literalinclude:: vroom.queries
:start-after: -- q1
:end-before: -- q2

Expand Down Expand Up @@ -124,7 +124,7 @@ Additional Example
Problem involving 2 jobs and 1 shipment, using a single vehicle, similar to the VROOM Documentation
`Example 2 <https://github.com/VROOM-Project/vroom/blob/master/docs/example_2.json>`__ with a shipment.

.. literalinclude:: doc-vrp_vroom.queries
.. literalinclude:: vroom.queries
:start-after: -- q2
:end-before: -- q3

Expand Down
4 changes: 2 additions & 2 deletions doc/vroom/vrp_vroomJobs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Optional parameters are `named parameters` and have a default value.
**Example**: This example is based on the modified VROOM Data of the :doc:`sampledata` network.
The modification in the tables is mentioned at the end of the :doc:`sampledata`.

.. literalinclude:: doc-vrp_vroomJobs.queries
.. literalinclude:: vroomJobs.queries
:start-after: -- q1
:end-before: -- q2

Expand Down Expand Up @@ -116,7 +116,7 @@ Additional Example
Problem involving 2 jobs, using a single vehicle, corresponding to the VROOM Documentation
`Example 2 <https://github.com/VROOM-Project/vroom/blob/master/docs/example_2.json>`__.

.. literalinclude:: doc-vrp_vroomJobs.queries
.. literalinclude:: vroomJobs.queries
:start-after: -- q2
:end-before: -- q3

Expand Down
4 changes: 2 additions & 2 deletions doc/vroom/vrp_vroomJobsPlain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Optional parameters are `named parameters` and have a default value.

**Example**: This example is based on the VROOM Data of the :doc:`sampledata` network:

.. literalinclude:: doc-vrp_vroomJobsPlain.queries
.. literalinclude:: vroomJobsPlain.queries
:start-after: -- q1
:end-before: -- q2

Expand Down Expand Up @@ -115,7 +115,7 @@ Additional Example
Problem involving 2 jobs, using a single vehicle, corresponding to the VROOM Documentation
`Example 2 <https://github.com/VROOM-Project/vroom/blob/master/docs/example_2.json>`__.

.. literalinclude:: doc-vrp_vroomJobsPlain.queries
.. literalinclude:: vroomJobsPlain.queries
:start-after: -- q2
:end-before: -- q3

Expand Down
4 changes: 2 additions & 2 deletions doc/vroom/vrp_vroomPlain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Optional parameters are `named parameters` and have a default value.

**Example**: This example is based on the VROOM Data of the :doc:`sampledata` network:

.. literalinclude:: doc-vrp_vroomPlain.queries
.. literalinclude:: vroomPlain.queries
:start-after: -- q1
:end-before: -- q2

Expand Down Expand Up @@ -123,7 +123,7 @@ Additional Example
Problem involving 2 jobs and 1 shipment, using a single vehicle, similar to the VROOM Documentation
`Example 2 <https://github.com/VROOM-Project/vroom/blob/master/docs/example_2.json>`__ with a shipment.

.. literalinclude:: doc-vrp_vroomPlain.queries
.. literalinclude:: vroomPlain.queries
:start-after: -- q2
:end-before: -- q3

Expand Down
4 changes: 2 additions & 2 deletions doc/vroom/vrp_vroomShipments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Optional parameters are `named parameters` and have a default value.
**Example**: This example is based on the modified VROOM Data of the :doc:`sampledata` network.
The modification in the tables is mentioned at the end of the :doc:`sampledata`.

.. literalinclude:: doc-vrp_vroomShipments.queries
.. literalinclude:: vroomShipments.queries
:start-after: -- q1
:end-before: -- q2

Expand Down Expand Up @@ -117,7 +117,7 @@ Problem involving 1 shipment, using a single vehicle, similar to the VROOM Docum
`Example 2 <https://github.com/VROOM-Project/vroom/blob/master/docs/example_2.json>`__ without jobs
and with a shipment.

.. literalinclude:: doc-vrp_vroomShipments.queries
.. literalinclude:: vroomShipments.queries
:start-after: -- q2
:end-before: -- q3

Expand Down
4 changes: 2 additions & 2 deletions doc/vroom/vrp_vroomShipmentsPlain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Optional parameters are `named parameters` and have a default value.

**Example**: This example is based on the VROOM Data of the :doc:`sampledata` network:

.. literalinclude:: doc-vrp_vroomShipmentsPlain.queries
.. literalinclude:: vroomShipmentsPlain.queries
:start-after: -- q1
:end-before: -- q2

Expand Down Expand Up @@ -116,7 +116,7 @@ Problem involving 1 shipment, using a single vehicle, similar to the VROOM Docum
`Example 2 <https://github.com/VROOM-Project/vroom/blob/master/docs/example_2.json>`__ without jobs
and with a shipment.

.. literalinclude:: doc-vrp_vroomShipmentsPlain.queries
.. literalinclude:: vroomShipmentsPlain.queries
:start-after: -- q2
:end-before: -- q3

Expand Down
12 changes: 12 additions & 0 deletions docqueries/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Do not use extensions
SET(LOCAL_FILES
version
full_version
)

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)
14 changes: 14 additions & 0 deletions docqueries/full_version.result
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
BEGIN;
BEGIN
SET client_min_messages TO NOTICE;
SET
/* -- q1 */
SELECT version, library FROM pgr_full_version();
version | library
-----------+-----------------
3.7.0-dev | pgrouting-3.7.0
(1 row)

/* -- q2 */
ROLLBACK;
ROLLBACK
8 changes: 4 additions & 4 deletions docqueries/or_tools/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
SET(LOCAL_FILES
doc-vrp_knapsack
doc-vrp_multiple_knapsack
doc-vrp_bin_packing
knapsack
multiple_knapsack
bin_packing
)

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)
set(PROJECT_DOC_FILES ${PROJECT_DOC_FILES} ${LOCAL_DOC_FILES} PARENT_SCOPE)
12 changes: 6 additions & 6 deletions docqueries/or_tools/test.conf
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
'comment' => 'Test for OR-Tools',
'activate' => 'true',
'tests' => [qw(
doc-vrp_knapsack
doc-vrp_multiple_knapsack
doc-vrp_bin_packing
knapsack
multiple_knapsack
bin_packing
)],

'documentation' => [qw(
doc-vrp_knapsack
doc-vrp_multiple_knapsack
doc-vrp_bin_packing
knapsack
multiple_knapsack
bin_packing
)],

'nottesting' => [qw(
Expand Down
6 changes: 3 additions & 3 deletions docqueries/pgr_pickDeliver/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Do not use extensions
SET(LOCAL_FILES
doc-pgr_pickDeliverEuclidean
doc-pgr_pickDeliver
doc-oneDepot
pgr_pickDeliverEuclidean
pgr_pickDeliver
oneDepot
)

foreach (f ${LOCAL_FILES})
Expand Down
13 changes: 6 additions & 7 deletions docqueries/pgr_pickDeliver/test.conf
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,22 @@
'any' => {
'comment' => 'pick deliver with dream db \n detailed execution 75 secs',
'tests' => [qw(
doc-pgr_pickDeliver
doc-pgr_pickDeliverEuclidean
doc-oneDepot
pgr_pickDeliver
pgr_pickDeliverEuclidean
oneDepot
)],

'documentation' => [qw(
doc-pgr_pickDeliver
doc-pgr_pickDeliverEuclidean
doc-oneDepot
pgr_pickDeliver
pgr_pickDeliverEuclidean
oneDepot
)],
'not-testing' => [qw(
past_example
jet_customers
differentVechiles
jet_customers1
book_from_query
doc-oneDepot
)]
},
);
Expand Down
12 changes: 12 additions & 0 deletions docqueries/test.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#!/usr/bin/perl -w

%main::tests = (
'any' => {
'files' => [qw(
version.pg
full_version.pg
)],
},
);

1;
14 changes: 14 additions & 0 deletions docqueries/version.result
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
BEGIN;
BEGIN
SET client_min_messages TO NOTICE;
SET
/* -- q1 */
SELECT pgr_version();
pgr_version
-------------
3.7.0-dev
(1 row)

/* -- q2 */
ROLLBACK;
ROLLBACK
4 changes: 2 additions & 2 deletions docqueries/version/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Do not use extensions
SET(LOCAL_FILES
doc-version
doc-full_version
version
full_version
)

foreach (f ${LOCAL_FILES})
Expand Down
8 changes: 4 additions & 4 deletions docqueries/version/test.conf
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
'any' => {
'comment' => 'vrprouting version',
'tests' => [qw(
doc-version
doc-full_version
version
full_version
)],

'documentation' => [qw(
doc-version
doc-full_version
version
full_version
)],

'dummyStorage' => [qw(
Expand Down
File renamed without changes.
12 changes: 6 additions & 6 deletions docqueries/vroom/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Do not use extensions
SET(LOCAL_FILES
doc-vrp_vroom
doc-vrp_vroomJobs
doc-vrp_vroomShipments
doc-vrp_vroomPlain
doc-vrp_vroomJobsPlain
doc-vrp_vroomShipmentsPlain
vroom
vroomJobs
vroomShipments
vroomPlain
vroomJobsPlain
vroomShipmentsPlain
)

foreach (f ${LOCAL_FILES})
Expand Down
Loading