Commit Graph

288 Commits

Author SHA1 Message Date
Mael Rouxel-Labbé adf8e5ad6a it's > its 2025-03-28 21:18:55 +01:00
Mael Rouxel-Labbé 7970fb99e7 later > latter 2025-03-28 20:41:37 +01:00
Sébastien Loriot b19515e1f8 Merge remote-tracking branch 'cgal/6.0.x-branch' 2025-01-24 08:09:18 +01:00
albert-github 8824b917ae Update Documentation/doc/resources/1.8.13/cgal_stylesheet.css
Co-authored-by: Sebastien Loriot <sloriot.ml@gmail.com>
2025-01-24 08:04:50 +01:00
albert-github 8a5cbddf72 Update Documentation/doc/resources/1.8.13/cgal_stylesheet.css
Co-authored-by: Sebastien Loriot <sloriot.ml@gmail.com>
2025-01-24 08:04:50 +01:00
albert-github 3aa58ef5fb Update Documentation/doc/resources/1.8.13/cgal_stylesheet.css
Looks like it is not necesary for the 1.8.13 version

Co-authored-by: Sebastien Loriot <sloriot.ml@gmail.com>
2025-01-24 08:04:50 +01:00
albert-github e36065c773 Correct icon sizes
Correct icon sizes
2025-01-24 08:04:50 +01:00
Sébastien Loriot 36d98614df Merge remote-tracking branch 'cgal/6.0.x-branch' 2025-01-09 19:23:19 +01:00
albert-github 0c338ca736 Doxygen incompatibility in respect to `FULL_SIDEBAR` setting
Due to an incompatibility change in doxygen (see 2a62c19755 (commitcomment-150534822)) it is necessary to add the setting for `FULL_SIDEBAR` to the setup of the CGAL documentation.
2024-12-25 12:23:59 +01:00
Laurent Rineau a269cd37a6 cgal_stylesheet.css must be taken from ../Manual
Revert "Merge pull request #8331 from albert-github/feature/bug_cgal_stylesheet"

This reverts commit 62de71bcfb, reversing
changes made to 3b4349cfbb.
2024-12-17 15:48:59 +01:00
albert-github 5c98f77ba2 LaTeX compliance for formulas and errors in bibliography
Correction of incorrect usage of LaTeX  in formulas and bibliography altough MatHJax and bibtex.pl doesn't always signal it.
- Incorrect biblio entry (missing `,` and `}`)
  - Documentation/doc/biblio/geom.bib
- `&nbsp` is not correct LaTex has to be `~`
  - Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt
  - Documentation/doc/Documentation/Developer_manual/Chapter_intro.txt
- Incorrect formula regarding usage of `\left` and `\right` (also signaled by MathJax
  - Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt
- `DeclareMathOperator` is a command that should be in the preamble, alternatively the command `\operatorname` can be used explicitly (as done here as it is only used once)
  - Kinetic_surface_reconstruction/doc/Kinetic_surface_reconstruction/Kinetic_surface_reconstruction.txt
- Latex has problems with `_` in a `text...` command so it should be escaped though this gives problems with MathJax hence the extra hook.
  MathJax reference: https://groups.google.com/g/mathjax-users/c/wSh6-hSIUpQ/m/KmzZhQQGslgJ
  - Documentation/doc/resources/1.10.0/CGAL_mathjax.js
  - Documentation/doc/resources/1.8.13/CGAL_mathjax.js
  - Documentation/doc/resources/1.9.6/CGAL_mathjax.js
  - Weights/include/CGAL/Weights/authalic_weights.h
2024-12-02 14:58:15 +01:00
Laurent Rineau 8e4ee1e45d update versions in menu_version.js
[skip ci]
2024-10-22 15:13:49 +02:00
Laurent Rineau 918744dade prepare the announcement of CGAL-6.0 2024-09-27 18:12:46 +02:00
albert-github 524ac0c049 Remove hardcoded extrastylesheet code
In the header files it was mentioned:
```
<!-- This should probably be an extrastylesheet instead of hardcoded. -->
<link href="$relpath$../Manual/cgal_stylesheet.css" rel="stylesheet" type="text/css" />
$extrastylesheet
```
this is now effectuated with this PR.
2024-07-03 12:45:21 +02:00
Laurent Rineau d68ef56d8d update the documentation menu 2024-02-28 15:19:40 +01:00
albert-github e23b535f7c Treeview missing due to missing setting in header.html
The PR #7946 was withdraw because the `$cookie` was not necessary anymore in the `header...`  files as it was part of the of the `$treeview`.
In `header_package.html` the `$treeview` has been disables and as such the `cookie.js` is not added/
Adding the `cookie.js` explicitly.

The effect was that there was a divider between the treeniew and the textual documentation but it was on the far left (and thus invisible), ith could be moved but after a refresh it was "gone" again.
2024-01-02 15:33:44 +01:00
Laurent Rineau 1672395b90 Merge pull request #7412 from HoffmannMichael/Kernel23-epic_trivial_constructions_doc-mh
Document exactness of constructions in Epick
2023-11-29 17:23:27 +01:00
Laurent Rineau fdcc7c7796 Merge remote-tracking branch 'cgal/master' into pr/afabri/7816
# Conflicts:
#	Installation/LICENSE
2023-11-29 16:45:10 +01:00
Laurent Rineau 36958928df remove opennl from Doxygen config
I checked the compilation of the documentation locally.
2023-11-29 16:38:58 +01:00
Sébastien Loriot 87b8695d8d Merge remote-tracking branch 'cgal/master' 2023-11-27 14:42:00 +01:00
Sébastien Loriot 1f8d66ba75 add macro in new resource dir 2023-11-16 11:36:09 +01:00
Sébastien Loriot cfac63f156 Merge remote-tracking branch 'cgal/master' into HEAD 2023-11-16 11:35:35 +01:00
Laurent Rineau ba46b785b1
Merge branch 'master' into Parameterization-no_opennl-GF 2023-11-15 16:33:49 +01:00
Laurent Rineau 5a587eeb51 Merge pull request #7758 from albert-github/feature/bug_setup_doxygen_master_1_10_0
Defining a new resource directory to be used with doxygen master 1.10.0
2023-11-15 15:45:41 +01:00
Sébastien Loriot 64c7d45ffb copy/paste issue 2023-11-15 12:21:44 +01:00
albert-github 8c9f391d87 Defining a new resource directory to be used with doxygen master 1.10.0
Adding the possibilities for the new setting `` so the CGAL setting don't interfere with the settings of other packages.
2023-11-09 12:46:06 +01:00
Andreas Fabri a77d8b36d1 cleanup 2023-11-02 12:21:07 +01:00
Laurent Rineau 51627e3505 Merge remote-tracking branch 'cgal/master' into CGAL-Qt6-GF
# Conflicts:
#	GraphicsView/demo/Bounding_volumes/CMakeLists.txt
2023-11-01 20:59:44 +01:00
albert-github ea970e6ef5 Defining a new resource directory to be used with doxygen master 1.10.0
Adding the, new, possibility for `HTML_COPY_CLIPBOARD`:
> If the `HTML_COPY_CLIPBOARD` tag is set to `YES` then doxygen will show an icon
> the top right of code and text fragments that allows the user to copy the contents to the clipboard (provided
> this is supported by the browser).
2023-10-17 10:59:44 +02:00
Laurent Rineau a5fcf016b7 Merge branch '5.6.x-branch'
# Conflicts:
#	Documentation/doc/resources/1.8.13/BaseDoxyfile.in
#	Documentation/doc/resources/1.9.6/BaseDoxyfile.in
2023-10-16 11:11:07 +02:00
albert-github d53d30a69b Defining a new resource directory to be used with doxygen master 1.10.0
Doxygen master 1.10.0 has support for the c++ concept of modules but as in the past doxygen used the term "modules" for the grouping of information (`commands like `\defgroup`, `\ingroup` etc.) an new term for the later has been introduced: Topics.
The introduction of the new term also has some influence on the generated files and file names.
The consequence of this is that part of CGAL documentation (i.e. the "Reference Manual") item didn't appear anymore in a.o. the treeview.
- creating a new setup
- adding the "topics" to the layout files as in the past the "modules" were.
- adjusting the "hack.js" where some manipulation of the TreeView is done and this had "modules" coded into it.
- adjusting the "header_packages.html" as this used the name "modules.js"
2023-10-05 13:27:54 +02:00
Jane Tournois 07dddbab95 remove Common dlls from package overview for Doxygen 1.8.13 2023-09-19 11:35:41 +02:00
Jane Tournois 904c0d6eec remove Common Dlls from package overview 2023-09-19 11:17:50 +02:00
Laurent Rineau 28632f21fc Merge branch 'master' into CGAL-Qt6-GF
# Conflicts:
#	Installation/CHANGES.md
2023-09-14 17:40:05 +02:00
Laurent Rineau 873c3b26cf remove a few occurrences of "qt5"
There are still a lot!
2023-09-11 17:46:27 +02:00
Laurent Rineau 46923342ad Merge pull request #7576 from albert-github/feature/issue_7395
issue #7395 Improvement of layout of model relations

# Conflicts:
#	Kernel_23/doc/Kernel_23/CGAL/Vector_2.h
2023-09-07 10:48:34 +02:00
Laurent Rineau c50c72fd28 Merge pull request #7648 from albert-github/feature/bug_pkgdesc_incl
Better showing of `#include`
2023-09-07 10:46:32 +02:00
Sébastien Loriot 608d0c81c4 use a macro 2023-08-24 14:56:48 +02:00
Sébastien Loriot 28f904f4e2 Merge remote-tracking branch 'cgal/master' 2023-08-15 07:16:14 +02:00
Andreas Fabri 959443253d Remove deprecated file 2023-07-28 12:41:45 +01:00
Laurent Rineau 454ac73b35 prepare CGAL-5.6 final version 2023-07-26 14:15:49 +02:00
albert-github 32054661c7 issue #7395 Improvement of layout of model relations
Replacing the `cgalModelsBare` construct with a `begin` / `end` construct so no less understandable constructs with `\,` and `\n` are necessary.
2023-07-21 19:21:09 +02:00
albert-github de3ba0f47c Merge remote-tracking branch 'upstream/master' into feature/issue_7395 2023-07-17 10:17:34 +02:00
Laurent Rineau ec1ab10e4c Merge pull request #7589 from albert-github/feature/bug_docu_setting
Possibility to disable special CGAL documentation setting
2023-07-17 09:52:20 +02:00
albert-github 4e5578d469 issue #7395 Improvement of layout of model relations
- based on review
2023-07-15 13:12:15 +02:00
albert-github a0320dd7b4 Merge branch 'master' into feature/issue_7395
# Conflicts:
#	Polyhedron/doc/Polyhedron/Concepts/PolyhedronItems_3.h
2023-07-13 10:33:18 +02:00
Laurent Rineau 4a2c7a668d Merge pull request #7571 from albert-github/feature/issue_7454
issue #7454 Consistency of BigO notations
2023-07-12 15:29:56 +02:00
albert-github 77020e946b Consistency of terms
Based on a remark in https://github.com/CGAL/cgal/pull/7576#issuecomment-1621587888 aslo changed here some names for consistency
2023-07-09 13:04:05 +02:00
albert-github 301728a8a9 issue #7395 Improvement of layout of model relations
- Completed the cgalModels part
2023-07-09 12:43:36 +02:00
albert-github 549e3a1710 Possibility to disable special CGAL documentation setting
In the past it was possible by means of the option `-DCGAL_EXTRACT_ALL_NO_DETAILED_IF_EMPTY=OFF` with CMake to disable the specific CGAL setting though currently with the 1.8.13 version this didn't work (anymore).
Also the setting has been renamed for the 1.9.6 version (and newer) to `NO_ADDITIONAL_DETAILS` this has now been made more flexible as well.
2023-07-07 14:29:42 +02:00