Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-2545

LaTeX support in Doxygen broken

    XMLWordPrintable

Details

    • Story
    • Status: Done
    • Resolution: Done
    • None
    • base
    • None

    Description

      LaTeX markup in Doxygen documentation ought to be rendered properly for display in HTML. It isn't: it's just dumped to the page as raw text. See, for example, the documentation for AffineTransform.

      Attachments

        Activity

          Doxgen can handle LaTeX by either rendering it to images and adding them to the HTML output, or by using MathJax. The default is the former; it is disabled if MathJax is enabled.

          Our current configuration sets

          USE_MATHJAX            = YES

          thereby disabling the default LaTeX support. However, we also set

          MATHJAX_RELPATH        = http://www.mathjax.org/mathjax

          which causes Doxygen to look for MathJax at http://www.mathjax.org/mathjax/MathJax.js, which is a 404.

          The correct MATHJAX_RELPATH is https://cdn.mathjax.org/mathjax/latest. Changing to that should fix the problem.

          swinbank John Swinbank added a comment - Doxgen can handle LaTeX by either rendering it to images and adding them to the HTML output, or by using MathJax. The default is the former; it is disabled if MathJax is enabled. Our current configuration sets USE_MATHJAX = YES thereby disabling the default LaTeX support. However, we also set MATHJAX_RELPATH = http://www.mathjax.org/mathjax which causes Doxygen to look for MathJax at http://www.mathjax.org/mathjax/MathJax.js , which is a 404. The correct MATHJAX_RELPATH is https://cdn.mathjax.org/mathjax/latest . Changing to that should fix the problem.

          People

            swinbank John Swinbank
            swinbank John Swinbank
            John Swinbank
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Jenkins

                No builds found.