Skip to content

Commit

Permalink
build based on 2d0a906
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jun 10, 2024
1 parent a6b69b9 commit dd91a0c
Show file tree
Hide file tree
Showing 16 changed files with 208 additions and 208 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-10T15:46:26","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-06-10T18:05:18","documenter_version":"1.4.1"}}
6 changes: 3 additions & 3 deletions dev/api-callbacks.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api-ctbase.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions dev/api-description.html

Large diffs are not rendered by default.

126 changes: 63 additions & 63 deletions dev/api-developers.html

Large diffs are not rendered by default.

42 changes: 21 additions & 21 deletions dev/api-diffgeom.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api-exceptions.html

Large diffs are not rendered by default.

152 changes: 76 additions & 76 deletions dev/api-model.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions dev/api-parser.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/api-plot.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
costate_style,
kwargs...
) -> Plots.Plot
</code></pre><p>Plot the optimal control solution <code>sol</code> using the layout <code>layout</code>.</p><p><strong>Notes.</strong></p><ul><li>The argument <code>layout</code> can be <code>:group</code> or <code>:split</code> (default).</li><li><code>control</code> can be <code>:components</code>, <code>:norm</code> or <code>:all</code>.</li><li><code>time</code> can be <code>:default</code> or <code>:normalized</code>.</li><li>The keyword arguments <code>state_style</code>, <code>control_style</code> and <code>costate_style</code> are passed to the <code>plot</code> function of the <code>Plots</code> package. The <code>state_style</code> is passed to the plot of the state, the <code>control_style</code> is passed to the plot of the control and the <code>costate_style</code> is passed to the plot of the costate.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/ae0c34ae55b09745d4dd8a2b4f8797a366598cbd/src/plot.jl#L253">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="RecipesBase.plot-Tuple{OptimalControlSolution}" href="#RecipesBase.plot-Tuple{OptimalControlSolution}"><code>RecipesBase.plot</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">plot(
</code></pre><p>Plot the optimal control solution <code>sol</code> using the layout <code>layout</code>.</p><p><strong>Notes.</strong></p><ul><li>The argument <code>layout</code> can be <code>:group</code> or <code>:split</code> (default).</li><li><code>control</code> can be <code>:components</code>, <code>:norm</code> or <code>:all</code>.</li><li><code>time</code> can be <code>:default</code> or <code>:normalized</code>.</li><li>The keyword arguments <code>state_style</code>, <code>control_style</code> and <code>costate_style</code> are passed to the <code>plot</code> function of the <code>Plots</code> package. The <code>state_style</code> is passed to the plot of the state, the <code>control_style</code> is passed to the plot of the control and the <code>costate_style</code> is passed to the plot of the costate.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/2d0a90687bf4f5d325f33269454593784c4aec5c/src/plot.jl#L257">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="RecipesBase.plot-Tuple{OptimalControlSolution}" href="#RecipesBase.plot-Tuple{OptimalControlSolution}"><code>RecipesBase.plot</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">plot(
sol::OptimalControlSolution;
layout,
control,
Expand All @@ -21,4 +21,4 @@
costate_style,
kwargs...
) -&gt; Any
</code></pre><p>Plot the optimal control solution <code>sol</code> using the layout <code>layout</code>.</p><p><strong>Notes.</strong></p><ul><li>The argument <code>layout</code> can be <code>:group</code> or <code>:split</code> (default).</li><li>The keyword arguments <code>state_style</code>, <code>control_style</code> and <code>costate_style</code> are passed to the <code>plot</code> function of the <code>Plots</code> package. The <code>state_style</code> is passed to the plot of the state, the <code>control_style</code> is passed to the plot of the control and the <code>costate_style</code> is passed to the plot of the costate.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/ae0c34ae55b09745d4dd8a2b4f8797a366598cbd/src/plot.jl#L341">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="api-parser.html">« Parser</a><a class="docs-footer-nextpage" href="api-print.html">Print »</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="Monday 10 June 2024 15:46">Monday 10 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><p>Plot the optimal control solution <code>sol</code> using the layout <code>layout</code>.</p><p><strong>Notes.</strong></p><ul><li>The argument <code>layout</code> can be <code>:group</code> or <code>:split</code> (default).</li><li>The keyword arguments <code>state_style</code>, <code>control_style</code> and <code>costate_style</code> are passed to the <code>plot</code> function of the <code>Plots</code> package. The <code>state_style</code> is passed to the plot of the state, the <code>control_style</code> is passed to the plot of the control and the <code>costate_style</code> is passed to the plot of the costate.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/2d0a90687bf4f5d325f33269454593784c4aec5c/src/plot.jl#L345">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="api-parser.html">« Parser</a><a class="docs-footer-nextpage" href="api-print.html">Print »</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="Monday 10 June 2024 18:05">Monday 10 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/api-print.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@
where x(t) ∈ R² and u(t) ∈ R.

<span class="sgr1">Declarations </span>(* required):
</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="api-plot.html">« Plot</a><a class="docs-footer-nextpage" href="api-repl.html">Repl »</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="Monday 10 June 2024 15:46">Monday 10 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="api-plot.html">« Plot</a><a class="docs-footer-nextpage" href="api-repl.html">Repl »</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="Monday 10 June 2024 18:05">Monday 10 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/api-repl.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Repl · CTBase.jl</title><meta name="title" content="Repl · CTBase.jl"/><meta property="og:title" content="Repl · CTBase.jl"/><meta property="twitter:title" content="Repl · CTBase.jl"/><meta name="description" content="Documentation for CTBase.jl."/><meta property="og:description" content="Documentation for CTBase.jl."/><meta property="twitter:description" content="Documentation for CTBase.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></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">CTBase.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="index.html">Introduction</a></li><li><span class="tocitem">API</span><ul><li><a class="tocitem" href="api-ctbase.html">CTBase.jl</a></li><li><a class="tocitem" href="api-description.html">Description</a></li><li><a class="tocitem" href="api-diffgeom.html">Differential geometry</a></li><li><a class="tocitem" href="api-exceptions.html">Exceptions</a></li><li><a class="tocitem" href="api-model.html">Model</a></li><li><a class="tocitem" href="api-parser.html">Parser</a></li><li><a class="tocitem" href="api-plot.html">Plot</a></li><li><a class="tocitem" href="api-print.html">Print</a></li><li class="is-active"><a class="tocitem" href="api-repl.html">Repl</a><ul class="internal"><li><a class="tocitem" href="#Index"><span>Index</span></a></li><li><a class="tocitem" href="#Documentation"><span>Documentation</span></a></li></ul></li><li><a class="tocitem" href="api-types.html">Types and functions</a></li><li><a class="tocitem" href="api-utils.html">Utils</a></li></ul></li><li><a class="tocitem" href="api-developers.html">Developers</a></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><a class="is-disabled">API</a></li><li class="is-active"><a href="api-repl.html">Repl</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="api-repl.html">Repl</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/control-toolbox/CTBase.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/control-toolbox/CTBase.jl/blob/main/docs/src/api-repl.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="Repl"><a class="docs-heading-anchor" href="#Repl">Repl</a><a id="Repl-1"></a><a class="docs-heading-anchor-permalink" href="#Repl" title="Permalink"></a></h1><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="api-repl.html#CTBase.ct_repl-Tuple{}"><code>CTBase.ct_repl</code></a></li></ul><h2 id="Documentation"><a class="docs-heading-anchor" href="#Documentation">Documentation</a><a id="Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="CTBase.ct_repl-Tuple{}" href="#CTBase.ct_repl-Tuple{}"><code>CTBase.ct_repl</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">ct_repl(; debug, demo, verbose) -&gt; Any
</code></pre><p>Create a ct REPL.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/ae0c34ae55b09745d4dd8a2b4f8797a366598cbd/src/repl.jl#L18">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="api-print.html">« Print</a><a class="docs-footer-nextpage" href="api-types.html">Types and functions »</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="Monday 10 June 2024 15:46">Monday 10 June 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><p>Create a ct REPL.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/control-toolbox/CTBase.jl/blob/2d0a90687bf4f5d325f33269454593784c4aec5c/src/repl.jl#L18">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="api-print.html">« Print</a><a class="docs-footer-nextpage" href="api-types.html">Types and functions »</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="Monday 10 June 2024 18:05">Monday 10 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 dd91a0c

Please sign in to comment.