diff options
| author | Martin Braun <martin.braun@ettus.com> | 2022-02-19 23:55:15 +0100 |
|---|---|---|
| committer | Aaron Rossetto <aaron.rossetto@ni.com> | 2022-02-24 13:38:05 -0600 |
| commit | f561910e3c1514eea9e08a22e83d8da22ff09242 (patch) | |
| tree | 81788a79defe35465537d95ce9df227d9ab055f9 | |
| parent | b170ec5d755b955196902d687e1614cb2ea46803 (diff) | |
| download | uhd-f561910e3c1514eea9e08a22e83d8da22ff09242.tar.gz uhd-f561910e3c1514eea9e08a22e83d8da22ff09242.tar.bz2 uhd-f561910e3c1514eea9e08a22e83d8da22ff09242.zip | |
cmake: doxygen: Make MATHJAX_RELPATH configurable via CMake
This is a Doxygen setting where to find MathJax. The default might not
be suitable for everyone, and in particular, if people already have MJ
installed on their local system, they might prefer using that instead of
an online one.
Example usage: Assume you have MathJax installed locally, e.g., through
the mathjax package on Fedora, or the libjs-mathjax package on
Debian/Ubuntu. Then you could build UHD as such:
cmake -DMATHJAX_RELPATH=/usr/share/javascript/mathjax
This will now use the local version. Note that locally generated HTML
documentation can now no longer be copied to other machines, unless they
also have MathJax installed to the same path.
| -rw-r--r-- | host/docs/CMakeLists.txt | 4 | ||||
| -rw-r--r-- | host/docs/Doxyfile.in | 2 |
2 files changed, 5 insertions, 1 deletions
diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt index 2b91fd4df..9f6b1eb2b 100644 --- a/host/docs/CMakeLists.txt +++ b/host/docs/CMakeLists.txt @@ -42,6 +42,10 @@ LIBUHD_REGISTER_COMPONENT("API/Doxygen" ENABLE_DOXYGEN ON "DOXYGEN_FOUND" OFF OF option(ENABLE_DOXYGEN_FULL "Use Doxygen to document the entire source tree (not just API)" OFF) option(ENABLE_DOXYGEN_DOT "Let Doxygen use dot (requires graphviz)" OFF) option(ENABLE_DOXYGEN_SHORTNAMES "Let Doxygen use shorter filenames (helps on Windows)" OFF) +set( + MATHJAX_RELPATH https://cdn.jsdelivr.net/npm/mathjax@2/ + CACHE STRING "MATHJAX_RELPATH option for Doxygen") +mark_as_advanced(MATHJAX_RELPATH) if(LIBUHDDEV_PKG) set(PKG_DOC_DIR share/doc/libuhd-dev) diff --git a/host/docs/Doxyfile.in b/host/docs/Doxyfile.in index fef2b8c0e..2a15c1cf6 100644 --- a/host/docs/Doxyfile.in +++ b/host/docs/Doxyfile.in @@ -1620,7 +1620,7 @@ MATHJAX_FORMAT = HTML-CSS # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. # This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2/ +MATHJAX_RELPATH = @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 |