Skip to content

Commit dee03ee

Browse files
committed
Updating release notes and news
1 parent 0446d44 commit dee03ee

File tree

2 files changed

+76
-39
lines changed

2 files changed

+76
-39
lines changed

NEWS.md

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,43 @@ To see all issues & pull requests closed by this release see the
1313
[#4.0.0](https://github.com/pgRouting/pgrouting/issues?utf8=%E2%9C%93&q=milestone%3A%22Release%204.0.0%22)
1414

1515

16+
Build
17+
18+
* C++ standard is std17
19+
20+
* Using this standard all versions of will work
21+
* The code is not yet modified to use std17:
22+
23+
* If needed: ``-DCMAKE_CXX_STANDARD=14`` to lower the standard.
24+
25+
* The user's documentation is build by default
26+
* The doxygen documentation is build by default
27+
28+
For developers:
29+
30+
* Set `-DUSE_CLANG_TIDY=ON` for clang tidy checks.
31+
* Tidy checks are done on CI.
32+
33+
Documentation build
34+
35+
* The doxygen documentation is build by default
36+
* The HTML documentation is build by default
37+
* The translated languages (en, es, zh_Hans) HTML documentation is build by default
38+
* `WITH-DOC` is not used anymore
39+
40+
User's Documentation is not build when
41+
42+
* Sphinx is not found
43+
* When all Sphinx formats are OFF
44+
* When all languages are OFF
45+
* Documentation output changed location to [build/doc/_build/](format) directory
46+
47+
* For example: for HTML output is on `build/doc/_build/html` directory
48+
49+
Developers's Documentation is not build when
50+
51+
* Doxygen is not found
52+
1653
Summary of changes by function
1754

1855
* pgr_aStar
@@ -454,25 +491,6 @@ Summary of functions and signatures no longer on pgrouting
454491
* [#2919](https://github.com/pgRouting/pgrouting/issues/2919) pgr_withpoints(text,text,text,boolean,character,boolean)
455492
* [#2919](https://github.com/pgRouting/pgrouting/issues/2919) pgr_withpointsvia(text,text,anyarray,boolean,boolean,boolean,character,boolean)
456493

457-
Documentation build
458-
459-
WITH-DOC is not used anymore
460-
461-
* The doxygen documentation is build by default
462-
* The HTML documentation is build by default
463-
* The translated languages (en, es, zh_Hans) HTML documentation is build by default
464-
465-
User's Documentation is not build when
466-
467-
* Sphinx is not found
468-
* When all Sphinx formats are OFF
469-
* When all languages are OFF
470-
* Output is on build/doc/_build/<format> directory
471-
472-
Developers's Documentation is not build when
473-
474-
* Doxygen is not found
475-
476494
Code enhancements
477495

478496
* Removal of unused C/C++ code

doc/src/release_notes.rst

Lines changed: 39 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,45 @@ To see all issues & pull requests closed by this release see the
4646
:local:
4747
:depth: 1
4848

49+
Build
50+
...............................................................................
51+
52+
* C++ standard is std17
53+
54+
* Using this standard all versions of boost will work
55+
* The code is not yet modified to use std17:
56+
57+
* If needed: ``-DCMAKE_CXX_STANDARD=14`` to lower the standard.
58+
59+
* The user's documentation is build by default
60+
* The doxygen documentation is build by default
61+
62+
For developers:
63+
64+
* Set `-DUSE_CLANG_TIDY=ON` for clang tidy checks.
65+
* Tidy checks are done on CI.
66+
67+
Documentation build
68+
...............................................................................
69+
70+
* The doxygen documentation is build by default
71+
* The HTML documentation is build by default
72+
* The translated languages (en, es, zh_Hans) HTML documentation is build by default
73+
* `WITH-DOC` is not used anymore
74+
75+
User's Documentation is not build when
76+
77+
* Sphinx is not found
78+
* When all Sphinx formats are OFF
79+
* When all languages are OFF
80+
* Documentation output changed location to `build/doc/_build/<format>` directory
81+
82+
* For example: for HTML output is on `build/doc/_build/html` directory
83+
84+
Developers's Documentation is not build when
85+
86+
* Doxygen is not found
87+
4988
Summary of changes by function
5089
...............................................................................
5190

@@ -524,26 +563,6 @@ Summary of functions and signatures no longer on pgrouting
524563
* :issue:`2919` pgr_withpoints(text,text,text,boolean,character,boolean)
525564
* :issue:`2919` pgr_withpointsvia(text,text,anyarray,boolean,boolean,boolean,character,boolean)
526565

527-
Documentation build
528-
...............................................................................
529-
530-
WITH-DOC is not used anymore
531-
532-
* The doxygen documentation is build by default
533-
* The HTML documentation is build by default
534-
* The translated languages (en, es, zh_Hans) HTML documentation is build by default
535-
536-
User's Documentation is not build when
537-
538-
* Sphinx is not found
539-
* When all Sphinx formats are OFF
540-
* When all languages are OFF
541-
* Output is on build/doc/_build/<format> directory
542-
543-
Developers's Documentation is not build when
544-
545-
* Doxygen is not found
546-
547566
Code enhancements
548567
...............................................................................
549568

0 commit comments

Comments
 (0)