summaryrefslogtreecommitdiff
path: root/src/common/doc
AgeCommit message (Collapse)Author
2022-06-15doc review: no need 'for this'Vincent Rouvreau
2022-06-13Merge remote-tracking branch 'albert/feature/bug__documentation_only' into ↵Vincent Rouvreau
doxygen_only
2022-05-24Merge pull request #623 from albert-github/feature/bug_gudhi_exampleVincent Rouvreau
Documentation: handling references to examples in a more transparent way
2022-05-23Documentation: handling references to examples in a more transparent wayalbert-github
Adding the other examples also with `gudhi_example_link`.
2022-05-23Update src/common/doc/installation.hVincent Rouvreau
2022-05-23Update src/common/doc/installation.hVincent Rouvreau
Co-authored-by: Marc Glisse <marc.glisse@inria.fr>
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-20Documentation: Updating redirected linksalbert-github
Updating simple links in documentation sources for which we got during link checking: ``` This is a permanent redirect. The link should be updated. ```
2022-05-20Documentation: make it easier to build only the documentationalbert-github
After review: - option is now: ``` -DWITH_GUDHI_CPP_DOCUMENTATION_ONLY=ON ``` - added some instructions to the installation description.
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
2022-05-17Missed reference found by VincentMarc Glisse
2022-03-24Update the main page of the docMarc Glisse
2022-02-10Boost 1.66.0 is now the minimal version as required from cgal 5.1 - Also ↵Vincent Rouvreau
remove useless include boost/version.h
2021-11-02Merge master and fix conflictsVincent Rouvreau
2021-08-31Fix broken links. Add a tool to generate cpp example pageROUVREAU Vincent
2021-08-12Merge pull request #506 from VincentRouvreau/test_another_sphinx_themesVincent Rouvreau
Test another sphinx themes
2021-08-05mailing lists migration and rephrase contributions in installation guidesROUVREAU Vincent
2021-06-25update headers, conf.py for the new theme and bottleneck image to be smallerROUVREAU Vincent
2021-05-12Merge from masterROUVREAU Vincent
2021-05-03Merge pull request #484 from VincentRouvreau/doxygen_improvementVincent Rouvreau
Doxygen documentation improvement
2021-04-27Doxygen documentation improvementROUVREAU Vincent
2021-04-27Remove make install target from python and rewrite documentation accordinglyROUVREAU Vincent
2021-04-22Add examples in doc and removes TBB link as not required by coxeterROUVREAU Vincent
2021-04-21cell complex is only for coxeter. eigen is required for coxeter, not cgalROUVREAU Vincent
2021-01-26Merge branch 'master' into coxeter_integrationROUVREAU Vincent
2020-11-01The example does not need CGAL/eigen anymore.Marc Glisse
I had done a search and replace without checking. I don't understand why there are "install" directives for examples...
2020-10-31s/kernel/distance/ for choose_n_farthest_points argumentMarc Glisse
2020-09-28Merge branch 'master' into coxeter_integrationROUVREAU Vincent
2020-09-23Add coxeter on main pageROUVREAU Vincent
2020-09-08CMake > 3.5 to use Boost targets. Compile only what is available from boost ↵ROUVREAU Vincent
targets
2020-08-21Add -DCMAKE_BUILD_TYPE=Release on installation docROUVREAU Vincent
2020-07-31New website header for pip downloadROUVREAU Vincent
2020-07-01doc review: fix some errorsROUVREAU Vincent
2020-06-15Add image for edge collapseROUVREAU Vincent
2020-06-02Move Edge collapse sectionROUVREAU Vincent
2020-05-25Merge last master versionROUVREAU Vincent
2020-05-11More DOI in the biblioMarc Glisse
and update references from a preprint to the published version
2020-04-28Code and doc review fixROUVREAU Vincent
2020-04-14Some documentation and examplesROUVREAU Vincent
2020-02-07Bad link for last versionROUVREAU Vincent
2020-01-20TypoMarc Glisse
2020-01-20Link kd-tree and subsampling from the main docMarc Glisse
2020-01-20Reorder skbl and toplexmap so that skbl is next to contractionsMarc Glisse
2020-01-20Missing entry in TOCMarc Glisse
2020-01-20Shuffle the modules on the main pageMarc Glisse
2020-01-10Merge pull request #195 from ↵Vincent Rouvreau
VincentRouvreau/alpha_complex_documentation_improvements Fix #105: Alpha-complex document parameter for the picture
2020-01-10Bug fix: a href tag was badly closedROUVREAU Vincent
2020-01-10Fix #105: Add alpha value on the picture, clarify simplices removal from the ↵ROUVREAU Vincent
Delaunay complex, use max_alpha_square=32 in the Python example
2019-12-12Code review: Typo in src/common/doc/installation.hVincent Rouvreau
Co-Authored-By: Marc Glisse <marc.glisse@inria.fr>
2019-12-09Document 'ctest --output-on-failure' in installation tests sectionROUVREAU Vincent
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-12 00:04:35 +0000