diff options
Diffstat (limited to 'src/common/doc')
| -rw-r--r-- | src/common/doc/header.html | 51 | ||||
| -rw-r--r-- | src/common/doc/installation.h | 14 | ||||
| -rw-r--r-- | src/common/doc/main_page.md | 6 |
3 files changed, 36 insertions, 35 deletions
diff --git a/src/common/doc/header.html b/src/common/doc/header.html index c12d2816..9fdb2321 100644 --- a/src/common/doc/header.html +++ b/src/common/doc/header.html @@ -25,62 +25,63 @@ $extrastylesheet <!-- GUDHI website header BEGIN --> <div id="navigation" class="sticky"> <nav class="top-bar" role="navigation" data-topbar> - <ul class="title-area"> - <li class="name"> - <h1 class="show-for-small-only"><a href="" class="icon-tree"> GUDHI C++ library</a></h1> - </li> - <!-- Remove the class "menu-icon" to get rid of menu icon. Take out "Menu" to just have icon alone --> - <li class="toggle-topbar menu-icon"><a href="#"><span>Navigation</span></a></li> - </ul> - <section class="top-bar-section"> - <ul class="right"> + <ul class="title-area"> + <li class="name"> + <h1 class="show-for-small-only"><a href="" class="icon-tree"> GUDHI library</a></h1> + </li> + <!-- Remove the class "menu-icon" to get rid of menu icon. Take out "Menu" to just have icon alone --> + <li class="toggle-topbar menu-icon"><a href="#"><span>Navigation</span></a></li> + </ul> + <section class="top-bar-section"> + <ul class="right"> <li class="divider"></li> <li><a href="/contact/">Contact</a></li> - </ul> - <ul class="left"> + </ul> + <ul class="left"> <li><a href="/"> <img src="/assets/img/home.png" alt=" GUDHI"> GUDHI </a></li> <li class="divider"></li> <li class="has-dropdown"> - <a href="#">Project</a> + <a href="#">Project</a> <ul class="dropdown"> <li><a href="/people/">People</a></li> <li><a href="/keepintouch/">Keep in touch</a></li> <li><a href="/partners/">Partners and Funding</a></li> <li><a href="/relatedprojects/">Related projects</a></li> <li><a href="/theyaretalkingaboutus/">They are talking about us</a></li> + <li><a href="/inaction/">GUDHI in action</a></li> </ul> </li> <li class="divider"></li> <li class="has-dropdown"> - <a href="#">Download</a> + <a href="#">Download</a> <ul class="dropdown"> <li><a href="/licensing/">Licensing</a></li> <li><a href="https://gforge.inria.fr/frs/download.php/latestzip/5253/library-latest.zip" target="_blank">Get the latest sources</a></li> - <li><a href="https://gforge.inria.fr/frs/download.php/latestzip/5280/utils_osx-latest.zip" target="_blank">Utils for Mac OSx</a></li> - <li><a href="https://gforge.inria.fr/frs/download.php/latestzip/5279/utils_win64-latest.zip" target="_blank">Utils for Win x64</a></li> + <li><a href="/conda/">Conda package</a></li> + <li><a href="/dockerfile/">Dockerfile</a></li> </ul> </li> <li class="divider"></li> <li class="has-dropdown"> - <a href="#">Documentation</a> + <a href="#">Documentation</a> <ul class="dropdown"> - <li><a href="/doc/latest/">C++ documentation</a></li> - <li><a href="/doc/latest/installation.html">C++ installation manual</a></li> - <li><a href="/python/latest/">Python documentation</a></li> - <li><a href="/python/latest/installation.html">Python installation manual</a></li> + <li><a href="/introduction/">Introduction</a></li> + <li><a href="https://gudhi.inria.fr/doc/latest/installation.html">C++ installation manual</a></li> + <li><a href="https://gudhi.inria.fr/doc/latest/">C++ documentation</a></li> + <li><a href="https://gudhi.inria.fr/python/latest/installation.html">Python installation manual</a></li> + <li><a href="https://gudhi.inria.fr/python/latest/">Python documentation</a></li> <li><a href="/utils/">Utilities</a></li> <li><a href="/tutorials/">Tutorials</a></li> - <li><a href="/dockerfile/">Dockerfile</a></li> </ul> </li> <li class="divider"></li> <li><a href="/interfaces/">Interfaces</a></li> <li class="divider"></li> - </ul> - </section> + </ul> + </section> </nav> -</div><!-- /#navigation --> -<!-- GUDHI website header BEGIN --> + </div><!-- /#navigation --> + <!-- GUDHI website header BEGIN --> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> diff --git a/src/common/doc/installation.h b/src/common/doc/installation.h index 2629d12c..54f86573 100644 --- a/src/common/doc/installation.h +++ b/src/common/doc/installation.h @@ -60,8 +60,8 @@ make doxygen * Having GMP version 4.2 or higher installed is recommended. * * \subsection cgal CGAL - * The \ref alpha_complex data structure, \ref bottleneck_distance, and few examples requires CGAL, which is a C++ - * library which provides easy access to efficient and reliable geometric algorithms. + * Some GUDHI modules (cf. \ref main_page "modules list"), and few examples require CGAL, a C++ library that provides + * easy access to efficient and reliable geometric algorithms. * * \note There is no need to install CGAL, you can just <CODE>cmake . && make</CODE> CGAL (or even * <CODE>cmake -DCGAL_HEADER_ONLY=ON .</CODE>), thereafter you will be able to compile @@ -125,13 +125,13 @@ make doxygen * \li <a href="_alpha_complex_2alpha_complex_3d_persistence_8cpp-example.html"> * Alpha_complex/alpha_complex_3d_persistence.cpp</a> * - * \subsection eigen3 Eigen3 - * The \ref alpha_complex data structure and few examples requires - * <a target="_blank" href="http://eigen.tuxfamily.org/">Eigen3</a> is a C++ template library for linear algebra: + * \subsection eigen Eigen + * Some GUDHI modules (cf. \ref main_page "modules list"), and few examples require + * <a target="_blank" href="http://eigen.tuxfamily.org/">Eigen</a> is a C++ template library for linear algebra: * matrices, vectors, numerical solvers, and related algorithms. * - * The following examples/utilities require the <a target="_blank" href="http://eigen.tuxfamily.org/">Eigen3</a> and will not be - * built if Eigen3 is not installed: + * The following examples/utilities require the <a target="_blank" href="http://eigen.tuxfamily.org/">Eigen</a> and will not be + * built if Eigen is not installed: * \li <a href="_alpha_complex_2_alpha_complex_from_off_8cpp-example.html"> * Alpha_complex/Alpha_complex_from_off.cpp</a> * \li <a href="_alpha_complex_2_alpha_complex_from_points_8cpp-example.html"> diff --git a/src/common/doc/main_page.md b/src/common/doc/main_page.md index ea2474be..d8cbf97f 100644 --- a/src/common/doc/main_page.md +++ b/src/common/doc/main_page.md @@ -50,7 +50,7 @@ <b>Author:</b> Vincent Rouvreau<br> <b>Introduced in:</b> GUDHI 1.3.0<br> <b>Copyright:</b> MIT [(GPL v3)](../../licensing/)<br> - <b>Requires:</b> \ref eigen3 and \ref cgal ≥ 4.11.0 + <b>Requires:</b> \ref eigen ≥ 3.1.0 and \ref cgal ≥ 4.11.0 </td> </tr> <tr> @@ -126,7 +126,7 @@ <b>Author:</b> Siargey Kachanovich<br> <b>Introduced in:</b> GUDHI 1.3.0<br> <b>Copyright:</b> MIT ([GPL v3](../../licensing/) for Euclidean version)<br> - <b>Euclidean version requires:</b> \ref eigen3 and \ref cgal ≥ 4.11.0 + <b>Euclidean version requires:</b> \ref eigen ≥ 3.1.0 and \ref cgal ≥ 4.11.0 </td> </tr> <tr> @@ -324,7 +324,7 @@ <b>Author:</b> Clément Jamin<br> <b>Introduced in:</b> GUDHI 2.0.0<br> <b>Copyright:</b> MIT [(GPL v3)](../../licensing/)<br> - <b>Requires:</b> \ref eigen3 and \ref cgal ≥ 4.11.0 + <b>Requires:</b> \ref eigen ≥ 3.1.0 and \ref cgal ≥ 4.11.0 </td> </tr> <tr> |