From f561910e3c1514eea9e08a22e83d8da22ff09242 Mon Sep 17 00:00:00 2001 From: Martin Braun Date: Sat, 19 Feb 2022 23:55:15 +0100 Subject: 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. --- host/docs/CMakeLists.txt | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'host/docs/CMakeLists.txt') 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) -- cgit v1.2.3