Commit Graph

197 Commits

Author SHA1 Message Date
Laurent Rineau d24b180293 Merge branch 'master' into gsoc2022-boost_np 2022-10-28 15:39:36 +02:00
Laurent Rineau a4248d0ca4 Update versions in the doc menu 2022-10-12 16:33:30 +02:00
Laurent Rineau b8e342d845 Update Documentation/doc/resources/1.9.3/menu_version.js
... with the same copy as the other versions!

Fix #6886.
2022-09-27 15:20:32 +02:00
Sébastien Loriot d191d4474a Revert "fix not documented warnings"
This reverts commit 8d773c56348c4055d963c57426d60d118915d22b.
2022-09-23 14:04:51 +02:00
Sébastien Loriot 6397378bdc fix not documented warnings 2022-09-23 13:29:40 +02:00
Sébastien Loriot d8f0bc4c08 dedicated macro for precondition 2022-09-21 09:42:32 +02:00
Sébastien Loriot 681120764e please the CI with a new macro 2022-09-21 09:36:41 +02:00
Laurent Rineau c96f5ddfe4 Merge pull request #6795 from albert-github/feature/bug_obsolete_transparent
Obsolete doxygen settings
2022-08-29 11:35:52 +02:00
albert-github e1a5a3cd1d Divider between treeview and text
In doxygen the setting `HTML_COLORSTYLE` has been introduced with as default `AUTO_LIGHT` but due to the current strategy of CGAL in respect to HTML stylesheets the divider between the treeview and the text is not properly  visible anymore. Due to the same strategy the setting to `AUTO_LIGHT` does not make sense for CGAL.
When setting `HTML_COLORSTYLE=LIGHT` the divider is properly visible again.
2022-08-17 12:30:35 +02:00
albert-github d1895dce99 Obsolete doxygen settings
In the current master the settings `DOT_TRANSPARENT` and `FORNULA_TRANSPARENT` are obsolete.
2022-08-11 13:42:49 +02:00
Sebastien Loriot cd883c678b
Merge pull request #6778 from albert-github/feature/bug_obsolete_dot
Replacing OBSOLETE doxygen settings
2022-08-03 19:58:49 +02:00
albert-github 07fb04e860 Replacing OBSOLETE doxygen settings
Replacing the doxygen obsolete settings with the new settings
2022-08-01 12:31:46 +02:00
albert-github 68a4fdcedc Confusing line numbers in case of warnings
Based on the problems with the line numbers in some warnings, see review of https://github.com/CGAL/cgal/pull/6688 one of the problems was the `ALIASES` for figures, here we have the code `\latexonly ^^ \endlatexonly` though the code in the `\latexonly` part should be LaTeX commands. Here the "attempted" newline is not necessary at all so the `^^` can be removed leaving an empty `\latexonly` part that can be removed as well.

There are a number of other numbering problems found in https://github.com/CGAL/cgal/pull/6688 but they are on the doxygen side as a proposed pull request https://github.com/doxygen/doxygen/pull/9465 has been submitted.
2022-07-21 18:47:08 +02:00
Laurent Rineau 10f5fa4f1e Prepare CGAL-5.5 2022-06-29 14:52:29 +02:00
Laurent Rineau 1cdf1ee26a Update menu_version.js 2022-05-19 16:50:57 +02:00
albert-github 939dfbe68a Documentation update in respect to code fragments
- Corrected some another const and mutable based on review
- Corrected BaseDoxyfile.in for other builds of this (5.5) version
2022-04-22 10:31:21 +02:00
albert-github 461dba692d Documentation update in respect to code fragments
Update of documentation in respect of code fragments
- making code fragments work in footnotes
- placing some words in in code tags
- completing some words to code tags
- removing some `#` as they are not necessary
- don't show obfuscation code in email
2022-04-21 17:56:14 +02:00
Laurent Rineau e7643c90d9 Merge branch '5.4.x-branch' 2022-01-31 17:29:17 +01:00
Laurent Rineau 959bbf105c CGAL-5.3.2 was not published today
... it will be published with CGAL-5.4.1.
2022-01-31 17:28:04 +01:00
Laurent Rineau e86b6f6643 Merge branch '5.4.x-branch' 2022-01-27 12:14:09 +01:00
Laurent Rineau c58ac97e93 Prepare 5.4.x-branch for the release of version 5.4 2022-01-27 12:12:21 +01:00
Sébastien Loriot 10b0af3092 rename macro since Named_function_parameter is part of STL_Extension 2022-01-13 14:43:34 +01:00
Sébastien Loriot c169c41240 Merge remote-tracking branch 'maxGimeno/PMP-Example_of_new_mp_function-maxGimeno' into HEAD 2022-01-12 13:33:49 +01:00
Laurent Rineau 20cdd62d07 Merge pull request #6230 from sloriot/CGAL-doxy_default
Update latest default
2022-01-12 11:41:26 +01:00
Sébastien Loriot e3a2eb8f23 update default 2022-01-10 11:29:46 +01:00
Sébastien Loriot 9112001f33 fix doc 2022-01-06 19:11:54 +01:00
Sébastien Loriot 9714557046 replace overloads with default parameters (PMP) 2022-01-05 14:41:46 +01:00
Sébastien Loriot a6d9b99466 move macros in BaseDoxyfile 2022-01-04 11:10:09 +01:00
Sébastien Loriot 67477b4fc0 add resource files for 1.9.3
cherry-picked from 011178da01
2021-12-27 08:33:21 +01:00
Laurent Rineau c5d01fc96e This branch now targets a possible 5.4-beta2 2021-12-17 17:41:29 +01:00
Laurent Rineau 2010a410e2 Prepare CGAL-5.4-beta1 2021-12-14 15:35:03 +01:00
Mael Rouxel-Labbé c14d65a858 Make the name of each named parameter selectable (doc) 2021-10-26 14:29:38 +02:00
Mael Rouxel-Labbé 521c72d57e Fix typos 2021-10-04 13:34:07 +02:00
Sébastien Loriot 011178da01 add resource files for 1.9.3 2021-08-24 14:36:54 +02:00
albert-github fab536d6f9 Interaction between `HAVE_DOT` setting and inheritance graph
In the BGL package we get a warning like:
```
/home/cgal-testsuite/cgal_doc_build/CGAL-5.4-Ic-33/doc/BGL/PackageDescription.txt:29: warning: ignoring \dot command because HAVE_DOT is not set
```
The BGL package uses the `\dot` and has now to use the setting `HAVE_DOT=YES` to see the dot image.
Till now this went OK as the `\dot` command didn't look at the setting of the `HAVE_DOT` setting in the Doxyfile, though by the issue https://github.com/doxygen/doxygen/issues/7273 and the pull request https://github.com/doxygen/doxygen/pull/8663 it is now required that `HAVE_DOT` is set.
The idea of setting `HAVE_DOT` for the BGL project removed the warning (and shows the figure again) though has also as side effect that the inheritance graphs are shown. Until now CGAL shows for the inheritance just the text version.

Doxygen now has for the `CLASS_GRAPH` setting the possibility `TEXT` that does exactly what is required.

Due to the general setting of `HAVE_DOT` also the not needed `graph_legend` was generated and some `INCLUDE_GRAPH`s, by setting this to `NO ` these are no suppressed as well.
2021-08-24 12:21:07 +02:00
albert-github 96d7986e41 Removing obsolete doxygen settings
```
warning: Tag 'LATEX_SOURCE_CODE' at line 1971 of file '.../doc_dxy/BaseDoxyfile' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'RTF_SOURCE_CODE' at line 2061 of file '.../doc_dxy/BaseDoxyfile' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 2166 of file '.../BaseDoxyfile' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
```
these tags have been declared obsolete (in the current master version), so they should be removed..
CGAL doesn't use the involved formats so this has no influence on the CGAL documentation processing.
2021-08-15 13:55:32 +02:00
Laurent Rineau b9743fffa3 Merge pull request #5741 from danston/Solvers-add_osqp-danston
[Small Feature] OSQP Support in Solver Interface
2021-07-27 15:55:23 +02:00
Sebastien Loriot 40f507a1f1
Merge pull request #5800 from MaelRL/SS-Doc_fixes-GF
Harmonization of some IO stream documentation
2021-07-19 07:56:48 +02:00
Mael 0426fd674c
Add the ASCII alias for doxygen 1.8.4 2021-07-08 23:58:14 +02:00
Laurent Rineau 484ee4c6c4 Change the release name, from 5.3-beta2 to 5.3
...and prepare for the near publication of 5.1.5 and 5.2.3.
2021-07-02 12:46:43 +02:00
Mael Rouxel-Labbé 78ff9185b3 Harmonize ASCII usage across all packages 2021-06-23 23:34:32 +02:00
Dmitry Anisimov 94b75803c0
Merge branch 'master' into Solvers-add_osqp-danston 2021-06-18 10:02:11 +02:00
Laurent Rineau 3dce682668 CGAL-5.3-beta1 was released 2021-06-11 09:58:18 +02:00
Laurent Rineau ac5d63d479 Prepare CGAL-5.3-beta1 2021-06-02 14:45:48 +02:00
Dmitry Anisimov 267a6412ac initial commit with the new osqp solver concept 2021-05-31 14:01:08 +02:00
Laurent Rineau 908049d7f4 Merge pull request #5715 from albert-github/feature/bug_formula_snap_def
Adding items to central MATHJAX_CODEFILE
2021-05-27 19:12:32 +02:00
Maxime Gimeno a76bd6081e Replace more sc text 2021-05-21 15:45:50 +02:00
albert-github b959a03f4b Adding items to central MATHJAX_CODEFILE
In pull request  #4644 a central MATHJAX_CODEFILE was introduced, but the snap rounding package was omitted, so this is corrected here.
For the MathJax V3 ( see #5707) this change is even mandatory (the current construct doesn't work).
2021-05-16 11:09:06 +02:00
albert-github 1b6548b0cc Extra white space at bottom of page
Below the bottom blue block we see for the packages some extra white space. For the Manual page this white space is not present.
The reason is the placing of the "hack.js" code.
2021-05-10 10:59:19 +02:00
Sébastien Loriot 72bc88d38f do not link in the macro 2021-04-08 18:28:24 +02:00