Deploying to gh-pages from @ 7ae38be 🚀

f3d-app · Jun 24, 2024 · 400a0ab · 400a0ab
1 parent 71cf4c6
commit 400a0ab
Show file tree

Hide file tree

Showing 9 changed files with 33 additions and 9 deletions.
diff --git a/assets/css/just-the-docs-dark.css b/assets/css/just-the-docs-dark.css
diff --git a/assets/css/just-the-docs-default.css b/assets/css/just-the-docs-default.css
diff --git a/assets/css/just-the-docs-light.css b/assets/css/just-the-docs-light.css
diff --git a/assets/js/search-data.json b/assets/js/search-data.json
@@ -71,7 +71,7 @@
   },"10": {
     "doc": "Generate",
     "title": "Generate",
-    "content": "# How to generate the full coverage report Requires `gcovr` program and `gcc` toolchain. 1. Build with `F3D_COVERAGE` option enabled. 2. Run all tests, `xdotool` needs to be installed. This will generate many `.gcda` files. 3. Generate the report with: `gcovr -r /path/to/sources --html --html-details -o coverage.html`. # How to build and test with sanitizer Requires `clang` toolchain. 1. Build with `F3D_SANITIZER` option to any of the possible values. 2. `export LSAN_OPTIONS=suppressions=/path/to/f3d/.lsan.supp:use_tls=0`. 3. `export TSAN_OPTIONS=suppressions=/path/to/f3d/.tsan.supp`. 4. Run all tests. # How to locally generate the jekyll based website 1. Install `ruby` and make sure ruby binaries directory is added to your `PATH` 2. Install jekyll and all dependencies: `gem install jekyll jekyll-remote-theme jekyll-relative-links jekyll-seo-tag jekyll-optional-front-matter jekyll-titles-from-headings` 3. Run jekyll locally: `jekyll server` 4. Open http://127.0.0.1:4000/ in a browser Please note the favicon and search bar are not working locally, this is expected. # How to locally generate the doxygen documentation 1. Install Python, pip and doxygen 2. `pip install sphinx sphinx-book-theme exhale` 3. `sphinx-build -M html ./library/doxygen /path/to/build` 4. `/path/to/build` directory now contains a html website ",
+    "content": "# How to generate the full coverage report Requires `gcovr` program and `gcc` toolchain. 1. Build with `F3D_COVERAGE` option enabled. 2. Run all tests, `xdotool` needs to be installed. This will generate many `.gcda` files. 3. Generate the report with: `gcovr -r /path/to/sources --html --html-details -o coverage.html`. # How to build and test with sanitizer Requires `clang` toolchain. 1. Build with `F3D_SANITIZER` option to any of the possible values. 2. `export LSAN_OPTIONS=suppressions=/path/to/f3d/.lsan.supp:use_tls=0`. 3. `export TSAN_OPTIONS=suppressions=/path/to/f3d/.tsan.supp`. 4. Run all tests. # How to locally generate the jekyll based website 1. Install `ruby` and make sure ruby binaries directory is added to your `PATH` 2. Install jekyll and all dependencies: `gem install jekyll jekyll-remote-theme jekyll-relative-links jekyll-seo-tag jekyll-optional-front-matter jekyll-titles-from-headings jekyll-include-cache` 3. Run jekyll locally: `jekyll server` 4. Open http://127.0.0.1:4000/ in a browser Please note the favicon and search bar are not working locally, this is expected. # How to locally generate the doxygen documentation 1. Install Python, pip and doxygen 2. `pip install sphinx sphinx-book-theme exhale` 3. `sphinx-build -M html ./library/doxygen /path/to/build` 4. `/path/to/build` directory now contains a html website ",
     "url": "/doc/dev/GENERATE.html",
 
     "relUrl": "/doc/dev/GENERATE.html"
@@ -197,7 +197,7 @@
   },"28": {
     "doc": "Installation",
     "title": "Installation",
-    "content": "# Installation ## Current release packages (2.4.0) | Platform | Files | -------- | ----- | Windows (installer) | [F3D-2.4.0-Windows.exe](https://github.com/f3d-app/f3d/releases/download/v2.4.0/F3D-2.4.0-Windows-x86_64-raytracing.exe) | Windows (portable) | [F3D-2.4.0-Windows.zip](https://github.com/f3d-app/f3d/releases/download/v2.4.0/F3D-2.4.0-Windows-x86_64-raytracing.zip) | MacOS (Intel) | [F3D-2.4.0-macOS-x86_64.dmg](https://github.com/f3d-app/f3d/releases/download/v2.4.0/F3D-2.4.0-macOS-x86_64-raytracing.dmg) | MacOS (Silicon) | [F3D-2.4.0-macOS-arm64.dmg](https://github.com/f3d-app/f3d/releases/download/v2.4.0/F3D-2.4.0-macOS-arm64-raytracing.dmg) | Linux (Debian package) | [F3D-2.4.0-Linux.deb](https://github.com/f3d-app/f3d/releases/download/v2.4.0/F3D-2.4.0-Linux-x86_64-raytracing.deb) | Linux (portable) | [F3D-2.4.0-Linux.tar.xz](https://github.com/f3d-app/f3d/releases/download/v2.4.0/F3D-2.4.0-Linux-x86_64-raytracing.tar.xz) | Note: MacOS package is not signed, see the [troubleshooting](/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html) section for a workaround if needed. ## Alternatives You can find other (headless, older, smaller, checksum, RCs) release related packages and files on the [releases page](https://github.com/f3d-app/f3d/releases). You can also find there the [nightly release](https://github.com/f3d-app/f3d/releases/tag/nightly) to test the development version of F3D. See the [desktop integration](/doc/user/DESKTOP_INTEGRATION.html) section in order actually integrate the binary release in your desktop. Alternatively, you can build F3D yourself by following the [build](/doc/dev/BUILD.html) guide. You can also find packages for the following repositories: ### Windows - [Scoop](https://scoop.sh/#/apps?q=f3d&s=0&d=1&o=true) ### MacOS - [Homebrew](https://formulae.brew.sh/formula/f3d) ### Linux - [Ubuntu](https://packages.ubuntu.com/search?keywords=f3d&searchon=names&exact=1&suite=all&section=all) - [Debian](https://packages.debian.org/search?keywords=f3d&searchon=names&exact=1&suite=all&section=all) - [Arch](https://archlinux.org/packages/extra/x86_64/f3d/) - [NixOS](https://search.nixos.org/packages?query=f3d) - [openSUSE](https://software.opensuse.org/package/f3d) - [OpenMandriva](https://github.com/OpenMandrivaAssociation/f3d) - [Mageia](https://madb.mageia.org/package/show/source/1/application/0/release/cauldron/name/f3d) - Fedora and others through [openSUSE OBS](https://build.opensuse.org/package/show/home:AndnoVember:F3D/f3d) - [Guix](https://packages.guix.gnu.org/packages/f3d/) - [Flathub](https://flathub.org/apps/details/io.github.f3d_app.f3d) ### Other - [FreeBSD](https://cgit.freebsd.org/ports/tree/graphics/f3d) - [Spack](https://packages.spack.io/package.html?name=f3d) - [pypi](https://pypi.org/project/f3d/) (library only) ",
+    "content": "# Installation ## Current release packages (2.4.0) | Platform | Files | -------- | ----- | Windows (installer) | [F3D-2.4.0-Windows.exe](https://github.com/f3d-app/f3d/releases/download/v2.4.0/F3D-2.4.0-Windows-x86_64-raytracing.exe) | Windows (portable) | [F3D-2.4.0-Windows.zip](https://github.com/f3d-app/f3d/releases/download/v2.4.0/F3D-2.4.0-Windows-x86_64-raytracing.zip) | MacOS (Intel) | [F3D-2.4.0-macOS-x86_64.dmg](https://github.com/f3d-app/f3d/releases/download/v2.4.0/F3D-2.4.0-macOS-x86_64-raytracing.dmg) | MacOS (Silicon) | [F3D-2.4.0-macOS-arm64.dmg](https://github.com/f3d-app/f3d/releases/download/v2.4.0/F3D-2.4.0-macOS-arm64-raytracing.dmg) | Linux (Debian package) | [F3D-2.4.0-Linux.deb](https://github.com/f3d-app/f3d/releases/download/v2.4.0/F3D-2.4.0-Linux-x86_64-raytracing.deb) | Linux (portable) | [F3D-2.4.0-Linux.tar.xz](https://github.com/f3d-app/f3d/releases/download/v2.4.0/F3D-2.4.0-Linux-x86_64-raytracing.tar.xz) | Note: MacOS package is not signed, see the [troubleshooting](/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html#macos) section for a workaround if needed. ## Alternatives You can find other (headless, older, smaller, checksum, RCs) release related packages and files on the [releases page](https://github.com/f3d-app/f3d/releases). You can also find there the [nightly release](https://github.com/f3d-app/f3d/releases/tag/nightly) to test the development version of F3D. See the [desktop integration](/doc/user/DESKTOP_INTEGRATION.html) section in order actually integrate the binary release in your desktop. Alternatively, you can build F3D yourself by following the [build](/doc/dev/BUILD.html) guide. You can also find packages for the following repositories: ### Windows - [Scoop](https://scoop.sh/#/apps?q=f3d&s=0&d=1&o=true) ### MacOS - [Homebrew](https://formulae.brew.sh/formula/f3d) ### Linux - [Ubuntu](https://packages.ubuntu.com/search?keywords=f3d&searchon=names&exact=1&suite=all&section=all) - [Debian](https://packages.debian.org/search?keywords=f3d&searchon=names&exact=1&suite=all&section=all) - [Arch](https://archlinux.org/packages/extra/x86_64/f3d/) - [NixOS](https://search.nixos.org/packages?query=f3d) - [openSUSE](https://software.opensuse.org/package/f3d) - [OpenMandriva](https://github.com/OpenMandrivaAssociation/f3d) - [Mageia](https://madb.mageia.org/package/show/source/1/application/0/release/cauldron/name/f3d) - Fedora and others through [openSUSE OBS](https://build.opensuse.org/package/show/home:AndnoVember:F3D/f3d) - [Guix](https://packages.guix.gnu.org/packages/f3d/) - [Flathub](https://flathub.org/apps/details/io.github.f3d_app.f3d) ### Other - [FreeBSD](https://cgit.freebsd.org/ports/tree/graphics/f3d) - [Spack](https://packages.spack.io/package.html?name=f3d) - [pypi](https://pypi.org/project/f3d/) (library only) ",
     "url": "/doc/user/INSTALLATION.html",
 
     "relUrl": "/doc/user/INSTALLATION.html"

diff --git a/assets/main.js b/assets/main.js
@@ -5,6 +5,25 @@ function onload(event) {
 }
 
 function enhance_install_page() {
+  function open_mac_warning_popup() {
+    const popup = document.createElement("div");
+    popup.classList = "popup-container bg-grey-dk-200";
+    popup.innerHTML = `
+        <h2>Warning</h2>
+        <p>MacOS package is not signed, if macOS complains that <b>the file is invalid, damaged or corrupted</b>, see the <a href="/doc/user/LIMITATIONS_AND_TROUBLESHOOTING.html#macos">troubleshooting section</a> for a workaround.</p>
+    `;
+
+    const button = document.createElement("button");
+    button.classList = "btn btn-primary";
+    button.innerHTML = "Ok";
+    button.addEventListener("click", function () {
+        popup.remove();
+    });
+    popup.append(button);
+
+    document.body.append(popup);
+  }
+
   function retrieve_downloads(target_platform_re) {
     var downloads = [];
     for (const table of document.querySelectorAll("table")) {
@@ -17,8 +36,12 @@ function enhance_install_page() {
               const link = table_cols[1].querySelector("a");
               if (link) {
                 const platform = table_cols[0].innerText;
+
                 if (target_platform_re.test(platform))
                   downloads.push([platform, link.innerText, link.href]);
+
+                if (/MacOS/i.test(platform))
+                  link.addEventListener("click", open_mac_warning_popup);
               }
             }
           }
@@ -56,6 +79,7 @@ function enhance_install_page() {
     link.setAttribute("href", url);
     link.setAttribute("class", i++ ? "btn" : "btn btn-primary");
     link.innerHTML = `<div>Get <b>F3D</b> for ${bolded_platform}</div><small>${filename}</small>`;
+    if (current_os === "MacOS") link.addEventListener("click", open_mac_warning_popup);
     div.append(link);
   }
   const note = document.createElement("div");

diff --git a/doc/dev/GENERATE.html b/doc/dev/GENERATE.html
diff --git a/doc/dev/GENERATE.md b/doc/dev/GENERATE.md
@@ -18,7 +18,7 @@ Requires `clang` toolchain.
 # How to locally generate the jekyll based website
 
 1. Install `ruby` and make sure ruby binaries directory is added to your `PATH`
-2. Install jekyll and all dependencies: `gem install jekyll jekyll-remote-theme jekyll-relative-links jekyll-seo-tag jekyll-optional-front-matter jekyll-titles-from-headings`
+2. Install jekyll and all dependencies: `gem install jekyll jekyll-remote-theme jekyll-relative-links jekyll-seo-tag jekyll-optional-front-matter jekyll-titles-from-headings jekyll-include-cache`
 3. Run jekyll locally: `jekyll server`
 4. Open http://127.0.0.1:4000/ in a browser
 

diff --git a/doc/user/INSTALLATION.html b/doc/user/INSTALLATION.html
diff --git a/doc/user/INSTALLATION.md b/doc/user/INSTALLATION.md
@@ -11,7 +11,7 @@
 | Linux (Debian package) | [F3D-2.4.0-Linux.deb](https://github.com/f3d-app/f3d/releases/download/v2.4.0/F3D-2.4.0-Linux-x86_64-raytracing.deb) |
 | Linux (portable) | [F3D-2.4.0-Linux.tar.xz](https://github.com/f3d-app/f3d/releases/download/v2.4.0/F3D-2.4.0-Linux-x86_64-raytracing.tar.xz) |
 
-Note: MacOS package is not signed, see the [troubleshooting](LIMITATIONS_AND_TROUBLESHOOTING.md) section for a workaround if needed.
+Note: MacOS package is not signed, see the [troubleshooting](LIMITATIONS_AND_TROUBLESHOOTING.md#macos) section for a workaround if needed.
 
 ## Alternatives