Skip to content

Commit

Permalink
build based on d9a5047
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jun 18, 2024
1 parent 7b1f24a commit 9f7874d
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-06-02T18:57:06","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-18T05:14:34","documenter_version":"1.4.1"}}
2 changes: 1 addition & 1 deletion dev/about/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>About · BernsteinExpansions.jl</title><meta name="title" content="About · BernsteinExpansions.jl"/><meta property="og:title" content="About · BernsteinExpansions.jl"/><meta property="twitter:title" content="About · BernsteinExpansions.jl"/><meta name="description" content="Documentation for BernsteinExpansions.jl."/><meta property="og:description" content="Documentation for BernsteinExpansions.jl."/><meta property="twitter:description" content="Documentation for BernsteinExpansions.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/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="BernsteinExpansions.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">BernsteinExpansions.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><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="../man/introduction/">Introduction</a></li><li><a class="tocitem" href="../man/range/">Range Enclosure</a></li><li><a class="tocitem" href="../man/benchmarks/">Benchmarks</a></li></ul></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="#Running-the-benchmarks"><span>Running the benchmarks</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/BernsteinExpansions.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/BernsteinExpansions.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="#Running-the-benchmarks">Running the benchmarks</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"><a class="docs-heading-anchor" href="#Branches">Branches</a><a id="Branches-1"></a><a class="docs-heading-anchor-permalink" href="#Branches" title="Permalink"></a></h3><p>Each pull request (PR) should be pushed in a new branch with the name of the author followed by a descriptive name, e.g. <code>t/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>t/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;BernsteinExpansions&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>This documentation is written in Markdown, and it relies on <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> to produce the HTML layout. To build the docs, run <code>make.jl</code>:</p><pre><code class="language-bash hljs">$ julia --color=yes docs/make.jl</code></pre><h2 id="Running-the-benchmarks"><a class="docs-heading-anchor" href="#Running-the-benchmarks">Running the benchmarks</a><a id="Running-the-benchmarks-1"></a><a class="docs-heading-anchor-permalink" href="#Running-the-benchmarks" title="Permalink"></a></h2><p>This package contains a suite of benchmarks that is handled through <a href="https://github.com/JuliaCI/PkgBenchmark.jl">PkgBenchmark</a>. To run the benchmarks, execute the following commands in Julia&#39;s REPL:</p><pre><code class="language-julia hljs">julia&gt; using BernsteinExpansions, PkgBenchmark
julia&gt; benchmarkpkg(&quot;BernsteinExpansions&quot;)</code></pre><p>To save the results to a custom directory, use:</p><pre><code class="language-julia hljs">julia&gt; benchmarkpkg(&quot;BernsteinExpansions&quot;, resultsdir=&quot;/Users/forets/Projects&quot;)</code></pre><p>For further options see the inline help of <code>benchmarkpkg</code>.</p><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><p>These persons have contributed to <code>BernsteinExpansions.jl</code> (in alphabetic order):</p><ul><li><a href="http://main.marcelo-forets.fr">Marcelo Forets</a></li><li><a href="http://www-verimag.imag.fr/~rocca/">Alexandre Rocca</a></li></ul></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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Sunday 2 June 2024 18:57">Sunday 2 June 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
julia&gt; benchmarkpkg(&quot;BernsteinExpansions&quot;)</code></pre><p>To save the results to a custom directory, use:</p><pre><code class="language-julia hljs">julia&gt; benchmarkpkg(&quot;BernsteinExpansions&quot;, resultsdir=&quot;/Users/forets/Projects&quot;)</code></pre><p>For further options see the inline help of <code>benchmarkpkg</code>.</p><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><p>These persons have contributed to <code>BernsteinExpansions.jl</code> (in alphabetic order):</p><ul><li><a href="http://main.marcelo-forets.fr">Marcelo Forets</a></li><li><a href="http://www-verimag.imag.fr/~rocca/">Alexandre Rocca</a></li></ul></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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Tuesday 18 June 2024 05:14">Tuesday 18 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 9f7874d

Please sign in to comment.