Commit Graph

288 Commits

Author SHA1 Message Date
Laurent Rineau 16f34ea6c6 Merge pull request #5236 from albert-github/feature/bug_https_redirect
Documentation of doxygen is at https server
2020-12-09 16:08:56 +01:00
Maxime Gimeno 1d98f0f71d Merge remote-tracking branch 'cgal/master' into CGAL_IO-maxGimeno 2020-12-09 14:40:02 +01:00
Laurent Rineau 6576d64bf7 Merge pull request #5226 from albert-github/feature/bug_advanced_end
Incorrect HTML code in relation with \cgalAdvancedEnd
2020-12-04 17:15:49 +01:00
albert-github 5d28a170bb Cherry-pick from PR #5237: Referencing non existing file
For a better quality also the close image was converted to an svg image, so the png does not exists anymore. This has to be reflected in this file as well.
2020-12-04 17:13:25 +01:00
albert-github 00760b5e9c Documentation of doxygen is at https server
Fix can also be applied for the older versions
2020-12-02 16:46:04 +01:00
albert-github 0ad5c59e24 Referencing non existing file
File slipped in, undoing (is in PR #5236)
2020-12-02 16:21:30 +01:00
albert-github 2d0b9cd3e4 Referencing non existing file
For a better quality also the close image was converted to an svg image, so the png does not exists anymore. This has to be reflected in this file as well.
2020-12-02 16:03:24 +01:00
albert-github 918a7cd374 Documentation of doxygen is at https server
To prevent extra redirects and a secure connection it is better to use `https` instead of `http` here.
2020-12-02 15:59:28 +01:00
albert-github c900353e91 Incorrect HTML code in relation with \cgalAdvancedEnd
Due to some subtle interactions between used doxygen commands and the defined `\cgalAdvancedEnd` incorrect HTML code is generated.
This was shown by `xmllint (and some options) as
```
parser error : Opening and ending tag mismatch: div line</td></tr>
```
With the `\noop` "trick" this can here be overcome.

The presented output though looked OK.
2020-11-30 14:58:29 +01:00
Laurent Rineau 1077767f79 Update menu_version.js after 5.0.4 and 5.1.1 2020-11-16 18:30:38 +01:00
Maxime Gimeno 3b70343590 Merge remote-tracking branch 'cgal/master' into CGAL_IO-maxGimeno 2020-11-16 16:19:43 +01:00
Laurent Rineau 1d9bebc673 Prepare CGAL-5.2-beta1 2020-11-13 16:37:15 +01:00
Sébastien Loriot a2122435e4 remove resource (very similar to 1.8.20) 2020-10-27 19:37:30 +01:00
Sébastien Loriot 0d534e2821 add resources for 1.8.20 2020-10-27 19:31:31 +01:00
Sébastien Loriot ae0067fa24 use SVG 2020-10-26 18:49:58 +01:00
Sébastien Loriot 3caa542096 add resource files for 1.8.19 + cmake update for version number 2020-10-26 18:39:06 +01:00
albert-github a2c624902e Missing search glass in search box of the documenttaion
Due to the change for the doxygen fix https://github.com/doxygen/doxygen/pull/7888 the file `mag_sel.png` is replaced by `mag_sel.svg`, as a result the search glass in the search box was not present anymore.
(Note this is only valid for versions 1.8.19 and newer).
2020-10-21 13:31:18 +02:00
Mael Rouxel-Labbé 4694a48913 Merge remote-tracking branch 'cgal/master' into CGAL_IO-maxGimeno 2020-09-22 11:35:25 +02:00
Laurent Rineau d00be189af Fix menu_version.js in the doc 2020-09-08 11:19:45 +02:00
Mael Rouxel-Labbé 8682f9bafb Merge remote-tracking branch 'cgal/master' into CGAL_IO-maxGimeno 2020-08-24 11:45:17 +02:00
Sébastien Loriot eab5aa962e apply f4d6c6fd15 to other resource files 2020-08-20 10:26:31 +02:00
albert-github f4d6c6fd15 Layout on the bibliography page
When having a bit a long citation description, the description runs, in the HTML output on the bibliography page, into 3 or more lines where the 3rd and following lines continue underneath the citation number like:
```
 [1]  Eric Berberich, Arno Eigenwillig, Michael Hemmer, Susan Hert, Lutz Kettner, Kurt Mehlhorn, Joachim Reichel, Susanne Schmitt, Elmar Schömer, and Nicola Wolpert. Exacus: Efficient and exact
       algorithms for curves and surfaces. In Gerth S. Brodal and Stefano Leonardi, editors, 13th Annual European Symposium on Algorithms (ESA 2005), volume 3669 of Lecture Notes in Computer Science,
pages 155–166, Palma de Mallorca, Spain, October 2005. European Association for Theoretical Computer Science (EATCS), Springer.
```

The example was found  in e.g. https://doc.cgal.org/latest/Algebraic_foundations/citelist.html

- corrected the "overflow"
- made the citation number right aligned
2020-08-11 13:26:23 +02:00
Laurent Rineau b94c11ec4c Update menu_version.js with newest versions 2020-08-03 11:56:29 +02:00
Mael Rouxel-Labbé 6f8a895671 Merge remote-tracking branch 'mine/CGAL-Improve_NP_doc_presentation-GF' into CGAL_IO-maxGimeno 2020-06-18 15:21:27 +02:00
Mael Rouxel-Labbé f6053b950f Mirror new NP changes to Doxygen resources 1.8.4 and 1.8.13 2020-06-18 14:18:41 +02:00
Mael Rouxel-Labbé 26eb7903aa Merge remote-tracking branch 'cgal/master' into CGAL-Improve_NP_doc_presentation-GF 2020-06-18 12:46:46 +02:00
Maxime Gimeno ea53a8d70d Merge remote-tracking branch 'cgal/master' into CGAL_IO-maxGimeno 2020-06-17 14:25:21 +02:00
Laurent Rineau 451202e61e Merge pull request #4759 from lrineau/Documentation-add_warning_about_doc_of_master-GF
Documentation: add warning about doc of master gf
2020-06-05 17:53:47 +02:00
Laurent Rineau daf86cc719 Prepare for 5.1-beta1 2020-06-04 09:42:02 +02:00
Laurent Rineau 821b909caf Use Sébastien's suggestion. CSS: the paragraph overflows 2020-06-02 11:13:49 +02:00
Laurent Rineau c3f200bbf3 Remove whitespace at end of lines 2020-06-02 10:47:22 +02:00
Laurent Rineau a443ad51cc Hack to add a warning for the documentation of master 2020-06-02 10:47:00 +02:00
Mael Rouxel-Labbé 038869cab9 Merge remote-tracking branch 'cgal/master' into CGAL-Improve_NP_doc_presentation-GF 2020-05-12 15:12:21 +02:00
Maxime Gimeno 049439fa6b Merge remote-tracking branch 'cgal/master' into CGAL_IO-maxGimeno 2020-04-30 16:47:58 +02:00
albert-github 876aa4c0bd Introducing CMake option CGAL_EXTRACT_ALL_NO_DETAILED_IF_EMPTY
When (re)generating the documentation from the sources and not using the, internally patched CGAL, doxygen version one gets messages about:
```
warning: ignoring unsupported tag 'EXTRACT_ALL_NO_DETAILED_IF_EMPTY'
```

By introducing the option `CGAL_EXTRACT_ALL_NO_DETAILED_IF_EMPTY` this doxygen setting can be steered
- option not supplied to cmake, will use as if specified  `-DCGAL_EXTRACT_ALL_NO_DETAILED_IF_EMPTY=ON`
- option supplied to cmake as `-DCGAL_EXTRACT_ALL_NO_DETAILED_IF_EMPTY=ON` will write the line `EXTRACT_ALL_NO_DETAILED_IF_EMPTY = YES` in the doxygen configuration
- option supplied to cmake as `-DCGAL_EXTRACT_ALL_NO_DETAILED_IF_EMPTY=OFF` will write the line `#EXTRACT_ALL_NO_DETAILED_IF_EMPTY = NO` in the doxygen configuration, so just using the default setting of `NO` line could be omitted but it is better to have a placeholder
2020-04-27 13:12:33 +02:00
Sébastien Loriot 3b52dfd7de Merge remote-tracking branch 'cgal/master' 2020-04-18 14:47:28 +02:00
albert-github 93e0eb11f9 Introducing central MATHJAX_CODEFILE
Removed extra pair of brackets
2020-04-16 19:00:04 +02:00
Mael Rouxel-Labbé f0532f9f31 Fix horizontal max width 2020-04-13 13:03:20 +02:00
albert-github e5177aa014 Introducing central MATHJAX_CODEFILE
Currently the needed extra definitions for MathJax usage (i.e. `\newcommand` and `\def` commaonds) are distributed over the header file and in a number of source code files.
Doxygen has the possibility for a centralize this by means of the MATHJAX_CODEFILE configuration setting, this has been implemented.
2020-04-13 12:37:57 +02:00
Mael Rouxel-Labbé 2337716bcd Merge remote-tracking branch 'cgal/master' into CGAL-Improve_NP_doc_presentation-GF 2020-04-12 20:46:35 +02:00
Sébastien Loriot 50c62be925 Merge remote-tracking branch 'cgal/releases/CGAL-5.0-branch' 2020-04-08 15:56:23 +02:00
Sébastien Loriot 947c838a6c Merge remote-tracking branch 'cgal/releases/CGAL-4.14-branch' 2020-04-08 15:55:15 +02:00
Sébastien Loriot 75f0b18224 remove deprecated config options 2020-04-07 14:31:36 +02:00
Mael Rouxel-Labbé c1a15f8c02 Add NPBegin macro with an argument (for VSA) 2020-04-05 17:57:10 +02:00
Mael Rouxel-Labbé fc79510388 Regroup NP aliases into the base doxyfile.in 2020-04-04 17:26:32 +02:00
Mael Rouxel-Labbé aac2efe8c7 Add some code to create collapsible named parameters 2020-03-27 20:23:40 +01:00
Mael Rouxel-Labbé 30d4754a04 Merge remote-tracking branch 'cgal/master' into CGAL_IO-maxGimeno 2020-03-17 09:03:12 +01:00
Laurent Rineau 5f58885213 menu_version.js for master 2020-02-25 13:22:46 +01:00
Laurent Rineau 3cc4dbddb1 Prepare new bug-fix releases 2020-02-25 09:50:53 +01:00
Laurent Rineau 5d0b60e0a8 Merge branch 'releases/CGAL-5.0-branch' 2020-01-27 11:25:19 +01:00
Laurent Rineau 7868c454e7 Next version on this branch will be 5.0.2 2020-01-27 11:24:09 +01:00
Mael Rouxel-Labbé d620198049 Merge branch 'CGAL_IO-maxGimeno-old' into CGAL_IO-maxGimeno 2020-01-17 12:34:08 +01:00
Andreas Fabri 784cd89fe5 20% -> auto 2019-12-12 15:04:15 +01:00
Andreas Fabri 963823c23d Do the same for 1.8.13 and 1.8.14 2019-12-12 08:52:39 +01:00
Andreas Fabri 0e81db0e56 Doxygen: More space for class names 2019-12-11 16:09:27 +01:00
Laurent Rineau f854a2816e Prepare the publication of 4.14.2 2019-11-08 11:37:45 +01:00
Laurent Rineau 27dcff6141 Prepare CGAL-5.0 finale version 2019-11-08 10:58:29 +01:00
Andreas Fabri 6d4a431b18 polish 2019-10-25 10:18:41 +02:00
Laurent Rineau e6da3c04f7 Merge pull request #4282 from sloriot/CGAL-doc_style_issue
Fix doc style issue
2019-10-15 16:31:36 +02:00
Sébastien Loriot fb5ef9ad68 fix issues in Related Functions background expension 2019-10-10 14:46:33 +02:00
Laurent Rineau b5412e7f42 Doxygen version menu 2019-09-30 16:19:18 +02:00
Maxime Gimeno 5a03f5d7c7 Continue working on the table 2019-09-25 15:52:18 +02:00
Sébastien Loriot db65bd8ecc Merge remote-tracking branch 'cgal/releases/CGAL-4.14-branch' 2019-04-11 21:38:48 +02:00
albert-github 1dd7473818 Correction of links
Correction of redirected links and links that moved to another place.
2019-04-11 21:37:05 +02:00
Laurent Rineau f33addc4cc Update the Javascript menu of the documentation 2019-04-05 15:14:02 +02:00
Laurent Rineau 5d56dff72f Late update or menu_version.js 2019-04-03 10:59:01 +02:00
Laurent Rineau 60478dd816 Merge pull request #3758 from albert-github/feature/bug_advanced_2
Correction of (X)HTML warnings in case of Advanced topics
2019-03-19 18:30:53 +01:00
Laurent Rineau ed8be0d44a Merge pull request #3771 from sloriot/Doc-generate_deprecation_notice
Use a generated version of deprecated.html

# Conflicts:
#	Documentation/doc/resources/1.8.13/deprecated.html
#	Documentation/doc/resources/1.8.14/deprecated.html
#	Documentation/doc/resources/1.8.4/deprecated.html
2019-03-19 18:28:58 +01:00
albert-github 28fdb2d425 Correction of (X)HTML warnings in case of Advanced topics
Based on suggestion of @sloriot using `^^` also in cgalAdvancedEnd instead of adding a new line in the files
2019-03-15 11:33:48 +01:00
Sébastien Loriot 6a7c377b40 Use a generated version of deprecated.html 2019-03-15 08:57:40 +01:00
Laurent Rineau e32637fa7c Merge pull request #3719 from albert-github/feature/bug_packages_html
Invalid (X)HTML sequence
2019-03-11 17:26:27 +01:00
albert-github 8b7f0bcb1e Correction of (X)HTML warnings in case of Advanced topics
Based on #3713 a  number of problems were solved, but also some new issues introduced.
- BaseDoxyfile.h see to it that the CGALAdvancedBegin is in a detailed part, so be sure to terminate the brief part by an extra carriage return
- commands like \pre, \note read till the beginning of the next section but a \htmlonly is not seen as a section separator, so insert an extra carriage return
- some places  missed an "Advanced" indicator, used the cgalAdvancedType here.

##Note
in Periodic_2_triangulation_2.h there appear to be a number of images that are a bit in thin air (Captions: "Insertion of a point on an edge." and "Insertion in a face."). Also just above these images theer are a number of functions that have documentation, but this is non-doxygen documentation and as such not seen by doxygen
2019-03-10 16:00:52 +01:00
Laurent Rineau f5836b2206 Merge branch 'releases/CGAL-4.13-branch' 2019-03-07 14:31:16 +01:00
Laurent Rineau 99fe1bc548 Merge branch 'releases/CGAL-4.12-branch' into releases/CGAL-4.13-branch 2019-03-07 14:26:47 +01:00
Sébastien Loriot 3887a21429 add missing text for brief of advanced class/type/function/concept 2019-03-05 08:01:17 +01:00
Sébastien Loriot f058854904 rename macro + apply to all version config files 2019-03-04 08:57:10 +01:00
Laurent Rineau 01e5727a50 Prepare CGAL-4.14-beta1 2019-03-01 16:27:11 +01:00
albert-github 2f3aeb7b9b Invalid (X)HTML sequence
Based on the discussion an updated implementation dropping the post processing step in favor of a `<div style=..` implementation
2019-02-28 19:29:49 +01:00
Sébastien Loriot 50a59c3096 add new macros to be used in classified reference manual 2019-02-14 10:27:26 +01:00
Laurent Rineau 50d501309c Merge branch 'releases/CGAL-4.12-branch' into releases/CGAL-4.13-branch 2019-02-13 15:39:58 +01:00
Laurent Rineau 2fa9206735 Merge pull request #3675 from sloriot/Doc-fix_nav_tree_hack
fix navtree hack
2019-02-13 15:38:10 +01:00
Sébastien Loriot d6cb114940 fix navtree hack
in recent doxygen version hash is always '#' making our check failing
The fix is to fallback to default used later one
2019-02-11 16:35:03 +01:00
Laurent Rineau ca858a3713 Merge pull request #3518 from albert-github/feature/bug_xhtml_address
XHTML address of dtd
2018-12-19 16:08:21 +01:00
Laurent Rineau 772da33fd5 Merge pull request #3519 from albert-github/feature/bug_xhtml_toc
XHTML problem regarding TOC definition
2018-12-19 16:08:18 +01:00
Laurent Rineau 5cd84de243 Merge pull request #3533 from albert-github/feature/bug_xhtml_problems
XHTML Problems regarding tag sequences
2018-12-19 16:06:37 +01:00
Laurent Rineau 41dfc2b6c3 Merge pull request #3534 from sloriot/Doc-fig_extra_end_p
avoid extra </p> after figures
2018-12-19 16:01:20 +01:00
Laurent Rineau c6798fb436 Merge pull request #3534 from sloriot/Doc-fig_extra_end_p
avoid extra </p> after figures
2018-12-19 15:45:48 +01:00
Sébastien Loriot 7e42c30647 avoid extra `</p>` after figures 2018-12-12 08:24:32 +01:00
albert-github 8f9510c3a4 XHTML Problems regarding tag sequences
XHTML is strict regarding tag sequences (contrary to HTML) in out case most of the times missing or superfluous p tags.
2018-12-11 19:31:25 +01:00
albert-github 14560b8e3c XHTML problem regarding TOC definition
Form the doxygen documentation:
Normally the contents between \htmlonly and \endhtmlonly is inserted as-is. When you want to insert a HTML
fragment that has block scope like a table or list which should appear outside <p>..</p>, this can lead to invalid
HTML. You can use \htmlonly[block] to make doxygen end the current paragraph and restart it after \endhtmlonly.
2018-12-08 15:15:27 +01:00
albert-github 66359c5d13 XHTML address of dtd
The address of the dtd for checking has changed from http -> https
2018-12-08 13:28:28 +01:00
Sébastien Loriot bc0bac113f close <link /> 2018-11-20 17:23:28 +01:00
Laurent Rineau 66e6a5575c Update the menu_version.js in `master`
See the dropdown menu at the top of:
  https://cgal.geometryfactory.com/CGAL/doc/master/
2018-11-13 14:24:52 +01:00
Laurent Rineau 775b7ce51b Merge pull request #3319 from maxGimeno/Documentaation-Fix_menu_version-GF
Documentation: Fix the version menu.
2018-09-17 11:36:26 +02:00
Sébastien Loriot d577065508 add favicon 2018-09-06 17:04:43 +02:00
Maxime Gimeno 726a7fccc1 If the current version of the doc is not in the array, display it
anyway. To be etested.
2018-09-05 15:52:39 +02:00
Laurent Rineau 7b0dbac0e6 Update menu_version.js with the link to 4.13-beta1 2018-07-31 16:06:22 +02:00
Laurent Rineau 0c4612e27d Update menu_version.js with new releases 2018-07-31 15:54:19 +02:00
Sébastien Loriot a0017d8219 fix mathjax default for doxygen 1.8.13 2018-05-30 14:28:08 +02:00
Laurent Rineau d34731d249 Merge pull request #3023 from maxGimeno/Documentation-Add_a_version_menu-GF
Doc: Add a menu for version selection in the doc header.
2018-04-16 14:50:40 +02:00
Laurent Rineau 2dae477bb1 Tweak the appearance (CSS) 2018-04-13 18:23:34 +02:00
Laurent Rineau 214034139d Fix the script 2018-04-13 17:42:27 +02:00
Maxime Gimeno 0161fe7c49 Add a menu for version selection to the doc. 2018-04-13 16:32:07 +02:00
Laurent Rineau 030cffa706 CSS tweaks, for CGAL-4.13
@sloriot agreed with the changes.
2018-04-11 10:06:55 +02:00
Sébastien Loriot 01af331c72 use https for all links to www.cgal.org and doc.cgal.org 2018-03-14 15:59:38 +01:00
Maxime Gimeno f4fe671a32 hide manual index for 1.8.4 also 2018-02-07 10:17:24 +01:00
Maxime Gimeno 181b002d3e Do the same for 1.8.14 2018-02-06 12:10:06 +01:00
Maxime Gimeno 8fec028ea5 Add some postprocessing for 1.8.13 2018-02-06 11:24:12 +01:00
Maxime Gimeno 7f90fe1fec Hide the broken index in Manual. 2018-02-05 15:02:33 +01:00
Sébastien Loriot d54113c18b Merge remote-tracking branch 'cgal/releases/CGAL-4.11-branch' 2018-01-30 11:22:39 +01:00
Sébastien Loriot 5e81643b53 let doxygen decide what is MATHJAX_RELPATH by default 2018-01-24 14:38:01 +01:00
Sébastien Loriot cbd08e1db7 use new URL for MathJax
https://www.mathjax.org/cdn-shutting-down/
2018-01-23 20:42:34 +01:00
Sébastien Loriot f10f072139 update config file of doxygen 1.8.14 2018-01-22 17:18:21 +01:00
Sébastien Loriot 85b4ad3271 restore 1.8.13 aliases and create new resource dir for 1.8.14
aliases from 1.8.13 and 1.8.14 are not compatible with each other
2018-01-22 17:05:03 +01:00
Sébastien Loriot 311ce10e6c replace "\n" with physical line break "^^" in aliases to please doxygen 1.8.14 2018-01-10 12:46:20 +01:00
Laurent Rineau e35cb74938 Merge branch 'releases/CGAL-4.10-branch' into releases/CGAL-4.11-branch 2017-11-29 18:32:10 +01:00
Laurent Rineau d8dce6fd88 resizeHeight no longer exist
I have verified in the template in Doxygen 1.8.13 and that line does not
exist.

... And it makes the script crash and report an error in the browser
console.
2017-11-28 11:42:41 +01:00
Laurent Rineau 92a6f5ef71 Merge branch 'releases/CGAL-4.10-branch' into releases/CGAL-4.11-branch 2017-08-28 14:19:02 +02:00
Laurent Rineau d5d8ddecba Import patch from PR #2366
Remove our CSS hacks, to "fix" the compilation with Doxygen 1.8.13
2017-08-28 14:17:48 +02:00
Laurent Rineau 4594430aac Merge pull request #2138 from sgiraudot/Point_set_processing-Las_IO-GF
Point set processing: LAS I/O
2017-07-17 12:45:24 +02:00
Simon Giraudot 40ae0436e1 Add C++11 conditions/tests/warnings for LAS and PLY IO functions and related files 2017-07-11 11:58:53 +02:00
Mael Rouxel-Labbé 3c42724e22 Merge branch 'Periodic_3_Regular_triangulation_3-APelle-old' into Periodic_3_Regular_triangulation_3-APelle
Based on Kernel_Weighted_point_without...
  @ 41e7520b3e
2017-06-15 15:07:53 +02:00
Maxime Gimeno 305807ef6d add cgal version 2017-04-13 10:31:24 +02:00
Maxime Gimeno 477196c52d clean-up 2017-02-06 16:31:48 +01:00
Mael Rouxel-Labbé a77272be94 Merge branch 'Periodic_3_Regular_triangulation_3-APelle-old' into Periodic_3_Regular_triangulation_3-APelle 2017-02-03 16:52:51 +01:00
Maxime Gimeno 60d0a39d42 fixes 2017-01-24 14:46:36 +01:00
Maxime Gimeno 82860688d1 Fix the doc to avoid diffs between 1.8.4 and 1.8.13 outputs 2017-01-24 09:39:23 +01:00
Maxime Gimeno b8b5b64dc2 Add XML output 2017-01-16 12:05:38 +01:00
Sébastien Loriot 7ef509d1bf add resource files for 1.8.13 patched
to be used with https://github.com/CGAL/doxygen/tree/release_1_8_13_patched
2016-12-29 17:14:10 +01:00
Sébastien Loriot d18f0ce0ba move more files to version specific resources 2016-12-29 15:38:12 +01:00
Sébastien Loriot 388c68dcc3 move resource files in a directory with the doxygen version it was generated for 2016-12-29 15:18:00 +01:00
Sébastien Loriot 8ec61532ff follow up of #900 2016-12-29 13:44:27 +01:00
Simon Giraudot cec789483d Reference tutorial page in sidebar menu and header menu 2016-03-10 16:14:37 +01:00
Monique Teillaud 9f1f87b24d Revert "update using "doxygen -u"" (let's not be earlier than master)
This reverts commit 3bc3a3d90face93c38750ec87517067b56727adb.
2016-01-17 20:03:14 +01:00
Monique Teillaud 4501417be1 update using "doxygen -u" 2016-01-17 20:03:13 +01:00
Philipp Möller 35d2e7f1b6 Move the bib files and adjust paths 2015-12-10 17:00:25 +01:00
Philipp Möller 992de97a7d Move BaseDoxyfile and associated stuff to resources 2015-12-10 17:00:24 +01:00
Philipp Möller f38324f747 Move scripts as well 2015-12-10 17:00:23 +01:00