build based on 87fc22b

JuliaReach · Nov 29, 2024 · c562553 · c562553
1 parent 5679c16
commit c562553
Show file tree

Hide file tree

Showing 23 changed files with 1,325 additions and 0 deletions.
diff --git a/previews/PR205/.documenter-siteinfo.json b/previews/PR205/.documenter-siteinfo.json
@@ -0,0 +1 @@
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-29T23:23:51","documenter_version":"1.8.0"}}
diff --git a/previews/PR205/about/index.html b/previews/PR205/about/index.html
@@ -0,0 +1,4 @@
+<!DOCTYPE html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>About · RangeEnclosures.jl</title><meta name="title" content="About · RangeEnclosures.jl"/><meta property="og:title" content="About · RangeEnclosures.jl"/><meta property="twitter:title" content="About · RangeEnclosures.jl"/><meta name="description" content="Documentation for RangeEnclosures.jl."/><meta property="og:description" content="Documentation for RangeEnclosures.jl."/><meta property="twitter:description" content="Documentation for RangeEnclosures.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script><link href="../assets/aligned.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt="RangeEnclosures.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">RangeEnclosures.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../tutorial/">Tutorial</a></li><li><span class="tocitem">Library</span><ul><li><a class="tocitem" href="../lib/types/">Types</a></li><li><a class="tocitem" href="../lib/methods/">Methods</a></li></ul></li><li class="is-active"><a class="tocitem" href>About</a><ul class="internal"><li><a class="tocitem" href="#Contributing"><span>Contributing</span></a></li><li><a class="tocitem" href="#Credits"><span>Credits</span></a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>About</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>About</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaReach/RangeEnclosures.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaReach/RangeEnclosures.jl/blob/master/docs/src/about.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="About"><a class="docs-heading-anchor" href="#About">About</a><a id="About-1"></a><a class="docs-heading-anchor-permalink" href="#About" title="Permalink"></a></h1><p>This page contains some general information about this project, and recommendations about contributing.</p><ul><li><a href="#About">About</a></li><li class="no-marker"><ul><li><a href="#Contributing">Contributing</a></li><li><a href="#Credits">Credits</a></li></ul></li></ul><h2 id="Contributing"><a class="docs-heading-anchor" href="#Contributing">Contributing</a><a id="Contributing-1"></a><a class="docs-heading-anchor-permalink" href="#Contributing" title="Permalink"></a></h2><p>If you like this package, consider contributing! You can send bug reports (or fix them and send your code), add examples to the documentation, or propose new features.</p><p>Below some conventions that we follow when contributing to this package are detailed. For specific guidelines on documentation, see the <a href="https://github.com/JuliaReach/LazySets.jl/wiki/Documentation-Guidelines">Documentations Guidelines wiki</a>.</p><h3 id="Branches-and-pull-requests-(PR)"><a class="docs-heading-anchor" href="#Branches-and-pull-requests-(PR)">Branches and pull requests (PR)</a><a id="Branches-and-pull-requests-(PR)-1"></a><a class="docs-heading-anchor-permalink" href="#Branches-and-pull-requests-(PR)" title="Permalink"></a></h3><p>We use a standard pull request policy: You work in a private branch and eventually add a pull request, which is then reviewed by other programmers and merged into the <code>master</code> branch.</p><p>Each pull request should be pushed in a new branch with the name of the author followed by a descriptive name, e.g., <code>mforets/my_feature</code>. If the branch is associated to a previous discussion in one issue, we use the name of the issue for easier lookup, e.g., <code>mforets/7</code>.</p><h3 id="Unit-testing-and-continuous-integration-(CI)"><a class="docs-heading-anchor" href="#Unit-testing-and-continuous-integration-(CI)">Unit testing and continuous integration (CI)</a><a id="Unit-testing-and-continuous-integration-(CI)-1"></a><a class="docs-heading-anchor-permalink" href="#Unit-testing-and-continuous-integration-(CI)" title="Permalink"></a></h3><p>This project is synchronized with GitHub Actions such that each PR gets tested before merging (and the build is automatically triggered after each new commit). For the maintainability of this project, it is important to make all unit tests pass.</p><p>To run the unit tests locally, you can do:</p><pre><code class="language-julia hljs">julia&gt; using Pkg
+
+julia&gt; Pkg.test(&quot;RangeEnclosures&quot;)</code></pre><p>We also advise adding new unit tests when adding new features to ensure long-term support of your contributions.</p><h3 id="Contributing-to-the-documentation"><a class="docs-heading-anchor" href="#Contributing-to-the-documentation">Contributing to the documentation</a><a id="Contributing-to-the-documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Contributing-to-the-documentation" title="Permalink"></a></h3><p>New functions and types should be documented according to our <a href="https://github.com/JuliaReach/LazySets.jl/wiki/Documentation-Guidelines">guidelines</a> directly in the source code.</p><p>You can view the source code documentation from inside the REPL by typing <code>?</code> followed by the name of the type or function. For example, the following command will print the documentation of the <code>enclose</code> function:</p><pre><code class="nohighlight hljs">julia&gt; ?enclose</code></pre><p>This documentation you are currently reading is written in Markdown, and it relies on <a href="https://juliadocs.github.io/Documenter.jl/stable/">Documenter.jl</a> to produce the HTML layout. The sources for creating this documentation are found in <code>docs/src</code>. You can easily include the documentation that you wrote for your functions or types there (see the <a href="https://juliadocs.github.io/Documenter.jl/stable/man/guide/">Documenter.jl guide</a> or our sources for examples).</p><p>To generate the documentation locally, run <code>make.jl</code>, e.g., by executing the following command in the terminal:</p><pre><code class="language-bash hljs">$ julia --color=yes docs/make.jl</code></pre><h2 id="Credits"><a class="docs-heading-anchor" href="#Credits">Credits</a><a id="Credits-1"></a><a class="docs-heading-anchor-permalink" href="#Credits" title="Permalink"></a></h2><h3 id="Core-developers"><a class="docs-heading-anchor" href="#Core-developers">Core developers</a><a id="Core-developers-1"></a><a class="docs-heading-anchor-permalink" href="#Core-developers" title="Permalink"></a></h3><p>The <code>RangeEnclosures.jl</code> library is maintained by (in alphabetic order):</p><ul><li><a href="https://github.com/lucaferranti">Luca Ferranti</a>, University of Vasaa</li><li><a href="http://github.com/mforets">Marcelo Forets</a>, Universidad de la República</li><li><a href="https://www.christianschilling.net/">Christian Schilling</a>, Aalborg University</li></ul><h3 id="Contributors"><a class="docs-heading-anchor" href="#Contributors">Contributors</a><a id="Contributors-1"></a><a class="docs-heading-anchor-permalink" href="#Contributors" title="Permalink"></a></h3><p>Huge thanks to all the <a href="https://github.com/JuliaReach/RangeEnclosures.jl/graphs/contributors">contributors</a>.</p><h3 id="Acknowledgments"><a class="docs-heading-anchor" href="#Acknowledgments">Acknowledgments</a><a id="Acknowledgments-1"></a><a class="docs-heading-anchor-permalink" href="#Acknowledgments" title="Permalink"></a></h3><p>We are grateful to the following persons for enlightening discussions during the preparation of this package:</p><ul><li><a href="https://github.com/lbenet">Luis Benet</a></li><li><a href="https://github.com/blegat/">Benoît Legat</a></li><li><a href="https://github.com/dpsanders/">David P. Sanders</a></li></ul><p>During Summer 2022, this project was financially supported by Google through the Google Summer of Code program. During Summer 2019, this project was financially supported by Julia through the Julia Season of Contributions program.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../lib/methods/">« Methods</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Friday 29 November 2024 23:23">Friday 29 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/previews/PR205/assets/aligned.css b/previews/PR205/assets/aligned.css
@@ -0,0 +1,3 @@
+p {
+  text-align: justify
+}