build based on 15c47dd

JuliaReach · Nov 27, 2024 · 6fdb7df · 6fdb7df
1 parent 2d34a49
commit 6fdb7df
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 9 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-18T16:10:35","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-27T22:21:28","documenter_version":"1.8.0"}}
diff --git a/dev/about/index.html b/dev/about/index.html
@@ -1,4 +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 · ControllerFormats.jl</title><meta name="title" content="About · ControllerFormats.jl"/><meta property="og:title" content="About · ControllerFormats.jl"/><meta property="twitter:title" content="About · ControllerFormats.jl"/><meta name="description" content="Documentation for ControllerFormats.jl."/><meta property="og:description" content="Documentation for ControllerFormats.jl."/><meta property="twitter:description" content="Documentation for ControllerFormats.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="ControllerFormats.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">ControllerFormats.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">Library</span><ul><li><a class="tocitem" href="../lib/ControllerFormats/">ControllerFormats module</a></li><li><a class="tocitem" href="../lib/Architecture/">Architecture module</a></li><li><a class="tocitem" href="../lib/FileFormats/">FileFormats module</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/ControllerFormats.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/ControllerFormats.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><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!</p><p><a href="https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue">Creating an issue</a> in the <a href="https://github.com/JuliaReach/ControllerFormats.jl/issues">ControllerFormats GitHub issue tracker</a> to report a bug, open a discussion about existing functionality, or suggest new functionality is appreciated.</p><p>If you have written code and would like it to be peer reviewed and added to the library, you can <a href="https://docs.github.com/en/get-started/quickstart/fork-a-repo">fork</a> the repository and send a pull request (see below).</p><p>You are also welcome to get in touch with us in the <a href="https://julialang.zulipchat.com/#narrow/stream/278609-juliareach">JuliaReach Zulip channel</a>.</p><p>Below we give some general comments about contributing to this package. The <a href="https://juliareach.github.io/JuliaReachDevDocs/latest/">JuliaReach development documentation</a> describes coding guidelines; take a look when in doubt about the coding style that is expected for the code that is finally merged into the library.</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 based on a 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 an issue, we use the number 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;ControllerFormats&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 the <a href="https://juliareach.github.io/JuliaReachDevDocs/latest/guidelines/#Writing-docstrings-1">JuliaReach development documentation</a>.</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.</p><p>The documentation you are currently reading is written in <a href="https://en.wikipedia.org/wiki/Markdown">Markdown</a>, and it relies on the package <a href="https://juliadocs.github.io/Documenter.jl/stable/">Documenter.jl</a> to produce the final 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 source code or <a href="https://juliadocs.github.io/Documenter.jl/stable/man/guide/"><code>Documenter</code>&#39;s guide</a> for examples).</p><p>To generate the documentation locally, run <code>docs/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><p>Here we list the names of the maintainers of the <code>ControllerFormats.jl</code> library, as well as past and present contributors (in alphabetic order).</p><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><ul><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><ul><li><a href="https://github.com/SebastianGuadalupe">Sebastián Guadalupe</a>, Universidad de la República</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../lib/FileFormats/">« FileFormats module</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="Monday 18 November 2024 16:10">Monday 18 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+julia&gt; Pkg.test(&quot;ControllerFormats&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 the <a href="https://juliareach.github.io/JuliaReachDevDocs/latest/guidelines/#Writing-docstrings-1">JuliaReach development documentation</a>.</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.</p><p>The documentation you are currently reading is written in <a href="https://en.wikipedia.org/wiki/Markdown">Markdown</a>, and it relies on the package <a href="https://juliadocs.github.io/Documenter.jl/stable/">Documenter.jl</a> to produce the final 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 source code or <a href="https://juliadocs.github.io/Documenter.jl/stable/man/guide/"><code>Documenter</code>&#39;s guide</a> for examples).</p><p>To generate the documentation locally, run <code>docs/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><p>Here we list the names of the maintainers of the <code>ControllerFormats.jl</code> library, as well as past and present contributors (in alphabetic order).</p><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><ul><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><ul><li><a href="https://github.com/SebastianGuadalupe">Sebastián Guadalupe</a>, Universidad de la República</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../lib/FileFormats/">« FileFormats module</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="Wednesday 27 November 2024 22:21">Wednesday 27 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>