summaryrefslogtreecommitdiff
path: root/src/Doxyfile.in
AgeCommit message (Collapse)Author
2022-06-08Merge branch 'master' into feature/bug_class_diagramsVincent Rouvreau
2022-05-24Merge pull request #630 from albert-github/feature/bug_mathjax_3Vincent Rouvreau
Documentation: Render formulas by means of MathJax 3
2022-05-24Documentation: Obsolete CLASS_DIARAMSalbert-github
Since doxygen version 1.9.3 the settings `CLASS_DIAGRAMS` and `CLASS_GRAPH` have been integrated into `CLASS_GRAPH` and `CLASS_DIAGRAMS` is now obsolete. The value of `CLASS+GRAPH` doesn't have to be adjusted, in this case, as it was already set to `NO`.
2022-05-24Documentation: Render formulas by means of MathJax 3albert-github
Based on review, made a switch between MathJax 2 and MathJax 3 based on the doxygen version
2022-05-23Documentation: Render formuals by means of MathJax 3albert-github
- create entries in Doxyfile.in for the use of MathJax - adjust formula so it is properly rendered in MathJax 3 (formula will also work with MathJax 2) (available in doxygen since doxygen 1.9.2)
2022-05-22Documentation: handling references to examples in a more transparent wayalbert-github
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.
2022-05-19Documentation: Doxygen warningsalbert-github
Based on review corrected `EXAMPLE_PATH` and `CITE_BIB_FILES`.
2022-05-18Documentation: Doxygen warningsalbert-github
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
2021-04-28update DoxyfileROUVREAU Vincent
2021-04-27Doxygen documentation improvementROUVREAU Vincent
2020-03-05remove ext (submodule directory) from doxygen parsingROUVREAU Vincent
2019-10-17fix documentation not being generated with Doxygen 1.8.16Jose Marino
2019-09-09Code review: rename cython as python (make target and directoryROUVREAU Vincent
2019-06-14Fix bad python3 namespace in doxygenROUVREAU Vincent
2019-06-14Remove gudhi_patches for CGAL and CGAL 4.11.0 is now the minimal CGAL ↵ROUVREAU Vincent
version required. Modification of documentation accordingly
2019-06-07Merge branch 'master' of github.com:GUDHI/gudhi-develROUVREAU Vincent
2019-06-07Try with a direct link to mathjax websiteROUVREAU Vincent
2019-06-05Fix #20: Add OFF section in file format and all documents target to it ↵ROUVREAU Vincent
instead of geomview.org documentation. Modify data/points/alphacomplexdoc.off in dimension 3 to be used as an example for OFF section in file format.
2019-05-28Use markdown for main page. Fix some doxyfileROUVREAU Vincent
2019-03-11Fix README.md file name renamed for Doxygen generationROUVREAU Vincent
2018-08-07Doxyfile is now generated to facilitate gudhi version packaging and new ↵vrouvrea
module process Doxyfile.in generates a build/src/Doxyfile that is copied by the user_version target (to avoid file generation in sources) git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ninja_cmake_warning_fix_vincent@3748 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 0a5ab637c2db102a59c994f03f0ec7fadbda3780
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-12 06:01:55 +0000