Commit Graph

112 Commits

Author SHA1 Message Date
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é 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
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
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
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
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
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