Skip to content

Commit

Permalink
build based on 2152556
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Apr 19, 2024
1 parent ecf0372 commit fa6887a
Show file tree
Hide file tree
Showing 69 changed files with 145,370 additions and 145,370 deletions.
2 changes: 1 addition & 1 deletion previews/PR343/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-19T08:14:31","documenter_version":"1.4.0"}}
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-19T13:20:14","documenter_version":"1.4.0"}}
2 changes: 1 addition & 1 deletion previews/PR343/developers/git/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
changes on master
=======
changes on your branch
&gt;&gt;&gt;&gt;&gt;&gt;&gt; mybranch</code></pre><p>and choose the changes that should be kept. Then you should <code>git add</code> the conflicting files, run <code>git rebase --continue</code>. See <a href="https://docs.github.com/en/github/using-git/resolving-merge-conflicts-after-a-git-rebase">here</a> for more information on this. In case you have may conflicting commits, the rebase can be tedious, you will even have to resolve conflicts for some changes in some earlier commit even if you reverted these changes in a later commit. To avoid this issue, it is recommended to first squash your commits into a single one. To do that, use</p><pre><code class="language-sh hljs">$ git rebase -i master</code></pre><p>and replace <code>pick</code> by <code>s</code> for all commits except the top one and then follow the instructions, see <a href="https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History">here</a> for more details.</p><h2 id="Switch-branches"><a class="docs-heading-anchor" href="#Switch-branches">Switch branches</a><a id="Switch-branches-1"></a><a class="docs-heading-anchor-permalink" href="#Switch-branches" title="Permalink"></a></h2><p>To switch to the branch <code>mybranch</code>, do the following.</p><h3 id="VSCode-7"><a class="docs-heading-anchor" href="#VSCode-7">VSCode</a><a class="docs-heading-anchor-permalink" href="#VSCode-7" title="Permalink"></a></h3><p>On the bottom left, you should see a sort of &quot;Y&quot; symbol with empty circles at the three leaves. On the right, you see the current branch. Click on it and then write or select <code>mybranch</code>.</p><h3 id="Git-bash-7"><a class="docs-heading-anchor" href="#Git-bash-7">Git bash</a><a class="docs-heading-anchor-permalink" href="#Git-bash-7" title="Permalink"></a></h3><p>First <a href="../setup/#Start-Git-bash">Start Git bash</a>.</p><pre><code class="language-sh hljs">$ git checkout mybranch</code></pre><h2 id="Format-your-code"><a class="docs-heading-anchor" href="#Format-your-code">Format your code</a><a id="Format-your-code-1"></a><a class="docs-heading-anchor-permalink" href="#Format-your-code" title="Permalink"></a></h2><p>To format your code, run the following in your Julia REPL. Make sure you have added <a href="https://github.com/domluna/JuliaFormatter.jl">JuliaFormatter.jl</a> before. </p><pre><code class="language-julia hljs">julia&gt; using JuliaFormatter; format(&quot;.&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../setup/">« Set up</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.0 on <span class="colophon-date" title="Friday 19 April 2024 08:14">Friday 19 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
&gt;&gt;&gt;&gt;&gt;&gt;&gt; mybranch</code></pre><p>and choose the changes that should be kept. Then you should <code>git add</code> the conflicting files, run <code>git rebase --continue</code>. See <a href="https://docs.github.com/en/github/using-git/resolving-merge-conflicts-after-a-git-rebase">here</a> for more information on this. In case you have may conflicting commits, the rebase can be tedious, you will even have to resolve conflicts for some changes in some earlier commit even if you reverted these changes in a later commit. To avoid this issue, it is recommended to first squash your commits into a single one. To do that, use</p><pre><code class="language-sh hljs">$ git rebase -i master</code></pre><p>and replace <code>pick</code> by <code>s</code> for all commits except the top one and then follow the instructions, see <a href="https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History">here</a> for more details.</p><h2 id="Switch-branches"><a class="docs-heading-anchor" href="#Switch-branches">Switch branches</a><a id="Switch-branches-1"></a><a class="docs-heading-anchor-permalink" href="#Switch-branches" title="Permalink"></a></h2><p>To switch to the branch <code>mybranch</code>, do the following.</p><h3 id="VSCode-7"><a class="docs-heading-anchor" href="#VSCode-7">VSCode</a><a class="docs-heading-anchor-permalink" href="#VSCode-7" title="Permalink"></a></h3><p>On the bottom left, you should see a sort of &quot;Y&quot; symbol with empty circles at the three leaves. On the right, you see the current branch. Click on it and then write or select <code>mybranch</code>.</p><h3 id="Git-bash-7"><a class="docs-heading-anchor" href="#Git-bash-7">Git bash</a><a class="docs-heading-anchor-permalink" href="#Git-bash-7" title="Permalink"></a></h3><p>First <a href="../setup/#Start-Git-bash">Start Git bash</a>.</p><pre><code class="language-sh hljs">$ git checkout mybranch</code></pre><h2 id="Format-your-code"><a class="docs-heading-anchor" href="#Format-your-code">Format your code</a><a id="Format-your-code-1"></a><a class="docs-heading-anchor-permalink" href="#Format-your-code" title="Permalink"></a></h2><p>To format your code, run the following in your Julia REPL. Make sure you have added <a href="https://github.com/domluna/JuliaFormatter.jl">JuliaFormatter.jl</a> before. </p><pre><code class="language-julia hljs">julia&gt; using JuliaFormatter; format(&quot;.&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../setup/">« Set up</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.0 on <span class="colophon-date" title="Friday 19 April 2024 13:19">Friday 19 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion previews/PR343/developers/setup/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@
23 # for example in EXAMPLES_UTILS
24 # literate_actions(joinpath(EXAMPLES_UTILS_DIR, example), OUTPUT_DIR)
25 # end
26 # literate_actions(joinpath(@__DIR__, &quot;src&quot;, &quot;Getting Started.jl&quot;), OUTPUT_DIR)</code></pre><p>This will speed up building the documentation quite a lot.</p><p>Now, build the documentation with:</p><pre><code class="language-julia hljs">julia&gt; include(&quot;docs/make.jl&quot;)</code></pre><p>To view it, open the file <code>docs/build/index.html</code> with your web browser.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../reference/Utils/">« Utils</a><a class="docs-footer-nextpage" href="../git/">Git »</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.0 on <span class="colophon-date" title="Friday 19 April 2024 08:14">Friday 19 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
26 # literate_actions(joinpath(@__DIR__, &quot;src&quot;, &quot;Getting Started.jl&quot;), OUTPUT_DIR)</code></pre><p>This will speed up building the documentation quite a lot.</p><p>Now, build the documentation with:</p><pre><code class="language-julia hljs">julia&gt; include(&quot;docs/make.jl&quot;)</code></pre><p>To view it, open the file <code>docs/build/index.html</code> with your web browser.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../reference/Utils/">« Utils</a><a class="docs-footer-nextpage" href="../git/">Git »</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.0 on <span class="colophon-date" title="Friday 19 April 2024 13:19">Friday 19 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit fa6887a

Please sign in to comment.