summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2022-05-23 18:35:22 +0200
committeralbert-github <albert.tests@gmail.com>2022-05-23 18:35:22 +0200
commitfc28a5b76e47518e616a186f5db5be2a251c4b91 (patch)
treefd3d91055dc4ee3aa59d9042fea2169cc9a2afa5
parent7e2fb7b6f5c9664e377a3211cb60aebec14e4d6e (diff)
Documentation: Render formuals by means of MathJax 3
- 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)
-rw-r--r--src/Alpha_complex/doc/Intro_alpha_complex.h2
-rw-r--r--src/Doxyfile.in16
2 files changed, 15 insertions, 3 deletions
diff --git a/src/Alpha_complex/doc/Intro_alpha_complex.h b/src/Alpha_complex/doc/Intro_alpha_complex.h
index 7f14f423..41e5e16d 100644
--- a/src/Alpha_complex/doc/Intro_alpha_complex.h
+++ b/src/Alpha_complex/doc/Intro_alpha_complex.h
@@ -107,6 +107,7 @@ Table of Contents
* \subsection filtrationcomputation Filtration value computation algorithm
* <br>
* \f$
+ * \begin{array}{l}
* \textbf{for } \text{i : dimension } \rightarrow 0 \textbf{ do}\\
* \quad \textbf{for all } \sigma \text{ of dimension i}\\
* \quad\quad \textbf{if } \text{filtration(} \sigma ) \text{ is NaN} \textbf{ then}\\
@@ -127,6 +128,7 @@ Table of Contents
* \textbf{end for}\\
* \text{make_filtration_non_decreasing()}\\
* \text{prune_above_filtration()}\\
+ * \end{array}
* \f$
*
* \subsubsection dimension2 Dimension 2
diff --git a/src/Doxyfile.in b/src/Doxyfile.in
index f76ba2bd..834fcfc1 100644
--- a/src/Doxyfile.in
+++ b/src/Doxyfile.in
@@ -1473,6 +1473,17 @@ FORMULA_TRANSPARENT = YES
USE_MATHJAX = YES
+# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
+# Note that the different versions of MathJax have different requirements with
+# regards to the different settings, so it is possible that also other MathJax
+# settings have to be changed when switching between the different MathJax
+# versions.
+# Possible values are: MathJax_2 and MathJax_3.
+# The default value is: MathJax_2.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_VERSION = MathJax_3
+
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. See the MathJax site (see:
# http://docs.mathjax.org/en/latest/output.html) for more details.
@@ -1494,15 +1505,14 @@ MATHJAX_FORMAT = HTML-CSS
# The default value is: http://cdn.mathjax.org/mathjax/latest.
# This tag requires that the tag USE_MATHJAX is set to YES.
-MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2
+MATHJAX_RELPATH =
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
# This tag requires that the tag USE_MATHJAX is set to YES.
-MATHJAX_EXTENSIONS = TeX/AMSmath \
- TeX/AMSsymbols
+MATHJAX_EXTENSIONS = ams
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# of code that will be used on startup of the MathJax code. See the MathJax site