Skip to content

Commit

Permalink
build based on 4c4aa67
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 29, 2023
1 parent 5628bec commit 73cc64c
Show file tree
Hide file tree
Showing 14 changed files with 29 additions and 29 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.9.3","generation_timestamp":"2023-10-29T01:49:00","documenter_version":"1.1.2"}}
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-29T17:47:37","documenter_version":"1.1.2"}}
26 changes: 13 additions & 13 deletions dev/api/index.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/blue_style/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/config/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
│ ├─ .JuliaFormatter.toml
│ └─ sub_code1.jl
└─ subdir2
└─ sub_code2.jl</code></pre><p>and call <code>format(&quot;dir&quot;)</code>, <code>code.jl</code> and <code>sub_code2.jl</code> will be formatted according to the rules defined in <code>dir/.JuliaFormatter.toml</code>, while formatting <code>sub_code1.jl</code> will be configured by <code>dir/subdir1/.JuliaFormatter.toml</code>.</p><h2 id="ignore"><a class="docs-heading-anchor" href="#ignore">Ignoring specific files and directories</a><a id="ignore-1"></a><a class="docs-heading-anchor-permalink" href="#ignore" title="Permalink"></a></h2><p>If there is an entry in <code>.JuliaFormatter.toml</code> with</p><pre><code class="nohighlight hljs">ignore = [&quot;file.jl&quot;, &quot;directory&quot;, &quot;file_*.jl&quot;]</code></pre><p>then all of these files will be reported as already formatted: <code>./file.jl</code>, <code>./directory/something.jl</code> <code>./other_directory/file.jl</code>, <code>file_1.jl</code>, <code>.other_directory/file_name.jl</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../sciml_style/">« SciML Style</a><a class="docs-footer-nextpage" href="../api/">API Reference »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 29 October 2023 01:49">Sunday 29 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
└─ sub_code2.jl</code></pre><p>and call <code>format(&quot;dir&quot;)</code>, <code>code.jl</code> and <code>sub_code2.jl</code> will be formatted according to the rules defined in <code>dir/.JuliaFormatter.toml</code>, while formatting <code>sub_code1.jl</code> will be configured by <code>dir/subdir1/.JuliaFormatter.toml</code>.</p><h2 id="ignore"><a class="docs-heading-anchor" href="#ignore">Ignoring specific files and directories</a><a id="ignore-1"></a><a class="docs-heading-anchor-permalink" href="#ignore" title="Permalink"></a></h2><p>If there is an entry in <code>.JuliaFormatter.toml</code> with</p><pre><code class="nohighlight hljs">ignore = [&quot;file.jl&quot;, &quot;directory&quot;, &quot;file_*.jl&quot;]</code></pre><p>then all of these files will be reported as already formatted: <code>./file.jl</code>, <code>./directory/something.jl</code> <code>./other_directory/file.jl</code>, <code>file_1.jl</code>, <code>.other_directory/file_name.jl</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../sciml_style/">« SciML Style</a><a class="docs-footer-nextpage" href="../api/">API Reference »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 29 October 2023 17:47">Sunday 29 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/custom_alignment/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,4 +133,4 @@
100 300 400
1 ee 40000
2 a b
]</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../transforms/">« Syntax Transforms</a><a class="docs-footer-nextpage" href="../custom_styles/">Custom Styles »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 29 October 2023 01:49">Sunday 29 October 2023</span>. Using Julia version 1.9.3.</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="../transforms/">« Syntax Transforms</a><a class="docs-footer-nextpage" href="../custom_styles/">Custom Styles »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 29 October 2023 17:47">Sunday 29 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/custom_styles/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@
foo(a, b, key1 = val1, key3 = val4)

julia&gt; format_text(s, style=CustomStyle()) |&gt; print
foo(a, b, key1=val1, key3=val4)</code></pre><p>Nice! Looks like it&#39;s working.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../custom_alignment/">« Custom Alignment</a><a class="docs-footer-nextpage" href="../yas_style/">YAS Style »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 29 October 2023 01:49">Sunday 29 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
foo(a, b, key1=val1, key3=val4)</code></pre><p>Nice! Looks like it&#39;s working.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../custom_alignment/">« Custom Alignment</a><a class="docs-footer-nextpage" href="../yas_style/">YAS Style »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 29 October 2023 17:47">Sunday 29 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/how_it_works/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@
...,
argument120
) # way over margin limit !!!
end</code></pre><blockquote><p>You can read how code is nested in the style section.</p></blockquote><p>Once the <code>FST</code> has been nested it&#39;s then printed out to a file and voila! You have a formatted version of your code!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Introduction</a><a class="docs-footer-nextpage" href="../style/">Code Style »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 29 October 2023 01:49">Sunday 29 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre><blockquote><p>You can read how code is nested in the style section.</p></blockquote><p>Once the <code>FST</code> has been nested it&#39;s then printed out to a file and voila! You have a formatted version of your code!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Introduction</a><a class="docs-footer-nextpage" href="../style/">Code Style »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 29 October 2023 17:47">Sunday 29 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,4 +180,4 @@

a * b
end
end</code></pre><p>Notice the contents of <code>@muladd begin</code> is not indented.</p><p><code>#!: format: noindent</code> can also be nested.</p><h2 id="Editor-Plugins"><a class="docs-heading-anchor" href="#Editor-Plugins">Editor Plugins</a><a id="Editor-Plugins-1"></a><a class="docs-heading-anchor-permalink" href="#Editor-Plugins" title="Permalink"></a></h2><p>For integration with other editors:</p><ul><li><a href="https://github.com/singularitti/vscode-julia-formatter/">VSCode</a></li><li><a href="https://codeberg.org/FelipeLema/julia-formatter.el">Emacs</a></li><li><a href="https://github.com/kdheepak/JuliaFormatter.vim">Vim</a></li><li><a href="https://github.com/JunoLab/Atom.jl">Atom (deprecated)</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="how_it_works/">How It Works »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 29 October 2023 01:49">Sunday 29 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre><p>Notice the contents of <code>@muladd begin</code> is not indented.</p><p><code>#!: format: noindent</code> can also be nested.</p><h2 id="Editor-Plugins"><a class="docs-heading-anchor" href="#Editor-Plugins">Editor Plugins</a><a id="Editor-Plugins-1"></a><a class="docs-heading-anchor-permalink" href="#Editor-Plugins" title="Permalink"></a></h2><p>For integration with other editors:</p><ul><li><a href="https://github.com/singularitti/vscode-julia-formatter/">VSCode</a></li><li><a href="https://codeberg.org/FelipeLema/julia-formatter.el">Emacs</a></li><li><a href="https://github.com/kdheepak/JuliaFormatter.vim">Vim</a></li><li><a href="https://github.com/JunoLab/Atom.jl">Atom (deprecated)</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="how_it_works/">How It Works »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 29 October 2023 17:47">Sunday 29 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/integrations/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
rev: &quot;v1.0.18&quot; # or whatever the desired release is
hooks:
- id: &quot;julia-formatter&quot;
# ... other repos you may have</code></pre><p>You can find a list of releases <a href="https://github.com/domluna/JuliaFormatter.jl/releases">here</a>. <strong>Be sure to use the entire version string!</strong> (You can double-check this by opening the release and looking at the part of the URL that follows <code>.../releases/tag/VERSION</code>.)</p></article><nav class="docs-footer"><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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 29 October 2023 01:49">Sunday 29 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
# ... other repos you may have</code></pre><p>You can find a list of releases <a href="https://github.com/domluna/JuliaFormatter.jl/releases">here</a>. <strong>Be sure to use the entire version string!</strong> (You can double-check this by opening the release and looking at the part of the URL that follows <code>.../releases/tag/VERSION</code>.)</p></article><nav class="docs-footer"><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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 29 October 2023 17:47">Sunday 29 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 73cc64c

Please sign in to comment.