| Age | Commit message (Collapse) | Author |
|---|
|
Doxygen only
|
|
|
|
issue #613 [cpp documentation] Footer needs to be generated with a more recent version of doxygen
|
|
Cech optimization
|
|
-Some other minor changes
-Change license to LGPL
|
|
|
|
doxygen_only
|
|
recent version of doxygen
With the doxygen versions <= 1.9.2 the default setting 'overflow: hidden;' causes problems.
With the commit:
```
Commit: 590198b416cd53313d150428d2f912586065ea0d [590198b]
Date: Wednesday, December 1, 2021 1:37:26 PM
issue #8924 Horizontal scroll bar missing in HTML for wide class="dotgraph" objects
```
for the doxygen 1.9.3 version this has already been corrected but to run properly with the <= 1.9.2 version
this setting is required
|
|
|
|
recent version of doxygen
The problem was that the update of the treeview was not called in the footer, though after correcting this some new problems occurred in respect to the treeview (the small pointers ran into the text) and with the in page table of cvontents (e.g. in installation.html).
- footer.html: call proper update function by means of `<div>`, as base the 1.9.4 version served but also older version work.
- stylesheet.css, Doxyfile.in: implemented as extra stylesheet and for the "small pointer" problem adjusted the `.arrow` settings
- header.html:
- placed the `<link rel="stylesheet" type="text/css" href="https://gudhi.inria.fr/assets/css/styles_feeling_responsive.css" />` more as an extra stylesheet as otherwise a second scrollbar would occur
- placed the `div id="top">` at the right place
- corrected `<img>` tag so it is properly closed (so XML compliant)
- corrected setting of `data-topbar` to `data-topbar=true` as HTML5 does not allow attributes without values.
|
|
|
|
Documentation: handling references to examples in a more transparent way
|
|
Adding the other examples also with `gudhi_example_link`.
|
|
|
|
Co-authored-by: Marc Glisse <marc.glisse@inria.fr>
|
|
In case we have the files`Bitmap_cubical_complex/Random_bitmap_cubical_complex.cpp` this will be linked to `_random_bitmap_cubical_complex_8cpp-example.html` and this is now hard coded.
When the setting of `CASE_SENSE_NAMES` is set to `YES` the mapping is to `Random_bitmap_cubical_complex_8cpp-example.html` but the hard coded link is still to `_random_bitmap_cubical_complex_8cpp-example.html` so the link cannot be resolved (at runtime!). Same could happen when the `CASE_SENSE_NAMES` is left blank and the the value is system dependent. It is unlikely that this happens but ...
By introducing the `ALIASES` `gudhi_example_link` this can be handled by doxygen in a more transparent way.
Furthermore wit 2 examples there was a double `cpp` in the text part, this has been corrected as well
Notre this solution supersedes #621 and maked #621 obsolete.
|
|
Updating simple links in documentation sources for which we got during link checking:
```
This is a permanent redirect. The link should be updated.
```
|
|
After review:
- option is now:
```
-DWITH_GUDHI_CPP_DOCUMENTATION_ONLY=ON
```
- added some instructions to the installation description.
|
|
When running doxygen on the sources we get (a.o.) the following warnings:
```
.../gudhi-devel/src/Contraction/include/gudhi/Edge_contraction.h:214: warning: unbalanced grouping commands
.../gudhi-devel/src/common/doc/examples.h:3: warning: the name 'Examples' supplied as the argument in the \file statement is not an input file
error: bib file .../gudhi-devel/biblio/how_to_cite_gudhi.bib not found!
.../gudhi-devel/src/common/doc/installation.h:271: warning: included file biblio/how_to_cite_gudhi.bib is not found. Check your EXAMPLE_PATH
```
This is corrected in the different files and in the settings in src/Doxyfile.in
Also there are a number of settings that are obsolete like:
```
warning: Tag 'LATEX_SOURCE_CODE' at line 1835 of file '.../gudhi-devel/build_windows_fork/Doxyfile' has become obsolete.
```
This is corrected in the src/Doxyfile.in file
|
|
|
|
|
|
|
|
|
|
remove useless include boost/version.h
|
|
|
|
|
|
|
|
Enable WITH_NETWORK option in some of the CI platforms (for a minimal testing)
|
|
|
|
Test another sphinx themes
|
|
|
|
|
|
|
|
Doxygen documentation improvement
|
|
|
|
|
|
|
|
|
|
|
|
I had done a search and replace without checking.
I don't understand why there are "install" directives for examples...
|
|
|
|
|
|
|
|
targets
|
|
|
|
|
|
|
|
|
|
|
|
|
