Skip to content

Commit

Permalink
build based on aaf2577
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 4, 2023
1 parent e735b2d commit 45292fe
Show file tree
Hide file tree
Showing 14 changed files with 286 additions and 258 deletions.
8 changes: 4 additions & 4 deletions dev/developers/contributing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@
Deleted no artifacts, repos, packages or scratchspaces</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; Pkg.develop(&quot;EquationOfStateRecipes&quot;)</code><code class="nohighlight hljs ansi" style="display:block;"> Cloning git-repo `https://github.com/MineralsCloud/EquationOfStateRecipes.jl.git`
Resolving package versions...
Updating `~/work/EquationOfStateRecipes.jl/EquationOfStateRecipes.jl/docs/Project.toml`
[8d49d7c9] ~ EquationOfStateRecipes v0.5.0 `~/work/EquationOfStateRecipes.jl/EquationOfStateRecipes.jl` ⇒ v0.5.0 `~/.julia/dev/EquationOfStateRecipes`
[8d49d7c9] ~ EquationOfStateRecipes v0.5.0 `~/work/EquationOfStateRecipes.jl/EquationOfStateRecipes.jl` ⇒ v0.5.1 `~/.julia/dev/EquationOfStateRecipes`
Updating `~/work/EquationOfStateRecipes.jl/EquationOfStateRecipes.jl/docs/Manifest.toml`
[8d49d7c9] ~ EquationOfStateRecipes v0.5.0 `~/work/EquationOfStateRecipes.jl/EquationOfStateRecipes.jl` ⇒ v0.5.0 `~/.julia/dev/EquationOfStateRecipes`</code></pre><p>Then the package will be cloned to your local machine. On *nix systems, the default path is <code>~/.julia/dev/EquationOfStateRecipes</code> unless you modify the <a href="http://docs.julialang.org/en/v1/manual/environment-variables/#JULIA_DEPOT_PATH-1"><code>JULIA_DEPOT_PATH</code></a> environment variable. If you&#39;re on Windows, this will be <code>C:\\Users\\&lt;my_name&gt;\\.julia\\dev\\EquationOfStateRecipes</code>. In the following text, we will call it <code>PKGROOT</code>.</p><p>Go to <code>PKGROOT</code>, start a new Julia session, and run</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; using Pkg</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; Pkg.instantiate()</code><code class="nohighlight hljs ansi" style="display:block;">Precompiling project...
[8d49d7c9] ~ EquationOfStateRecipes v0.5.0 `~/work/EquationOfStateRecipes.jl/EquationOfStateRecipes.jl` ⇒ v0.5.1 `~/.julia/dev/EquationOfStateRecipes`</code></pre><p>Then the package will be cloned to your local machine. On *nix systems, the default path is <code>~/.julia/dev/EquationOfStateRecipes</code> unless you modify the <a href="http://docs.julialang.org/en/v1/manual/environment-variables/#JULIA_DEPOT_PATH-1"><code>JULIA_DEPOT_PATH</code></a> environment variable. If you&#39;re on Windows, this will be <code>C:\\Users\\&lt;my_name&gt;\\.julia\\dev\\EquationOfStateRecipes</code>. In the following text, we will call it <code>PKGROOT</code>.</p><p>Go to <code>PKGROOT</code>, start a new Julia session, and run</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; using Pkg</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; Pkg.instantiate()</code><code class="nohighlight hljs ansi" style="display:block;">Precompiling project...
<span class="sgr33"></span>EquationOfStateRecipes
<span class="sgr33"></span><span class="sgr90">EquationOfStateRecipes → PlotsExt</span>
2 dependencies successfully precompiled in 8 seconds. 180 already precompiled.
2 dependencies successfully precompiled in 9 seconds. 180 already precompiled.
<span class="sgr33">2</span> dependencies precompiled but different versions are currently loaded. Restart julia to access the new versions</code></pre><p>to instantiate the project.</p><h3 id="Step-4:-checkout-a-new-branch"><a class="docs-heading-anchor" href="#Step-4:-checkout-a-new-branch">Step 4: checkout a new branch</a><a id="Step-4:-checkout-a-new-branch-1"></a><a class="docs-heading-anchor-permalink" href="#Step-4:-checkout-a-new-branch" title="Permalink"></a></h3><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>In the following, replace any instance of <code>GITHUB_ACCOUNT</code> with your GitHub username.</p></div></div><p>The next step is to check out a development branch. In a terminal (or command prompt on Windows), run:</p><pre><code class="language-bash hljs">$ cd ~/.julia/dev/EquationOfStateRecipes

$ git remote add GITHUB_ACCOUNT https://github.com/GITHUB_ACCOUNT/EquationOfStateRecipes.jl.git
Expand Down Expand Up @@ -47,4 +47,4 @@

$ git checkout main

$ git pull</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If you have suggestions to improve this guide, please make a pull request! It&#39;s particularly helpful if you do this after your first pull request because you&#39;ll know all the parts that could be explained better.</p></div></div><p>Thanks for contributing to EquationOfStateRecipes!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../lib/public/">« Public API</a><a class="docs-footer-nextpage" href="../style-guide/">Style Guide »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Saturday 2 September 2023 02:32">Saturday 2 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
$ git pull</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If you have suggestions to improve this guide, please make a pull request! It&#39;s particularly helpful if you do this after your first pull request because you&#39;ll know all the parts that could be explained better.</p></div></div><p>Thanks for contributing to EquationOfStateRecipes!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../lib/public/">« Public API</a><a class="docs-footer-nextpage" href="../style-guide/">Style Guide »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Monday 4 September 2023 09:12">Monday 4 September 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/developers/design-principles/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/developers/style-guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

julia&gt; using JuliaFormatter: format

julia&gt; format(&quot;docs&quot;); format(&quot;src&quot;); format(&quot;test&quot;)</code></pre><div class="admonition is-info"><header class="admonition-header">Info</header><div class="admonition-body"><p>A continuous integration check verifies that all PRs made to EquationOfStateRecipes have passed the formatter.</p></div></div><p>The following sections outline extra style guide points that are not fixed automatically by JuliaFormatter.</p><h3 id="Use-the-Julia-extension-for-Visual-Studio-Code"><a class="docs-heading-anchor" href="#Use-the-Julia-extension-for-Visual-Studio-Code">Use the Julia extension for Visual Studio Code</a><a id="Use-the-Julia-extension-for-Visual-Studio-Code-1"></a><a class="docs-heading-anchor-permalink" href="#Use-the-Julia-extension-for-Visual-Studio-Code" title="Permalink"></a></h3><p>Please use <a href="https://code.visualstudio.com/">Visual Studio Code</a> with the <a href="https://marketplace.visualstudio.com/items?itemName=julialang.language-julia">Julia extension</a> to edit, format, and test your code. For the time being, we do not recommend using editors other than Visual Studio Code to edit your code.</p><p>This extension already has <a href="https://github.com/domluna/JuliaFormatter.jl">JuliaFormatter</a> integrated. So to format your code, follow the steps listed <a href="https://www.julia-vscode.org/docs/stable/userguide/formatter/">here</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../contributing/">« Contributing</a><a class="docs-footer-nextpage" href="../design-principles/">Design Principles »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Saturday 2 September 2023 02:32">Saturday 2 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
julia&gt; format(&quot;docs&quot;); format(&quot;src&quot;); format(&quot;test&quot;)</code></pre><div class="admonition is-info"><header class="admonition-header">Info</header><div class="admonition-body"><p>A continuous integration check verifies that all PRs made to EquationOfStateRecipes have passed the formatter.</p></div></div><p>The following sections outline extra style guide points that are not fixed automatically by JuliaFormatter.</p><h3 id="Use-the-Julia-extension-for-Visual-Studio-Code"><a class="docs-heading-anchor" href="#Use-the-Julia-extension-for-Visual-Studio-Code">Use the Julia extension for Visual Studio Code</a><a id="Use-the-Julia-extension-for-Visual-Studio-Code-1"></a><a class="docs-heading-anchor-permalink" href="#Use-the-Julia-extension-for-Visual-Studio-Code" title="Permalink"></a></h3><p>Please use <a href="https://code.visualstudio.com/">Visual Studio Code</a> with the <a href="https://marketplace.visualstudio.com/items?itemName=julialang.language-julia">Julia extension</a> to edit, format, and test your code. For the time being, we do not recommend using editors other than Visual Studio Code to edit your code.</p><p>This extension already has <a href="https://github.com/domluna/JuliaFormatter.jl">JuliaFormatter</a> integrated. So to format your code, follow the steps listed <a href="https://www.julia-vscode.org/docs/stable/userguide/formatter/">here</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../contributing/">« Contributing</a><a class="docs-footer-nextpage" href="../design-principles/">Design Principles »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Monday 4 September 2023 09:12">Monday 4 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
10 changes: 5 additions & 5 deletions dev/index.html

Large diffs are not rendered by default.

Loading

0 comments on commit 45292fe

Please sign in to comment.