Skip to content

Commit

Permalink
build based on d21c32f
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Dec 5, 2024
1 parent 3855816 commit c217582
Show file tree
Hide file tree
Showing 10 changed files with 19 additions and 19 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.11.1","generation_timestamp":"2024-11-19T07:04:47","documenter_version":"1.8.0"}}
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-12-05T21:17:10","documenter_version":"1.8.0"}}
2 changes: 1 addition & 1 deletion dev/config/index.html

Large diffs are not rendered by default.

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

julia> mygreeting()
&quot;Hello, world!&quot;</code></pre><p>Now, in your editor modify <code>mygreeting</code> to do this:</p><pre><code class="language-julia hljs">mygreeting() = &quot;Hello, revised world!&quot;</code></pre><p>and then try it in the same session:</p><pre><code class="language-julia hljs">julia&gt; mygreeting()
&quot;Hello, revised world!&quot;</code></pre><p>As described above, the first revision you make may be very slow, but later revisions should be fast.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../config/">« Configuration</a><a class="docs-footer-nextpage" href="../limitations/">Limitations »</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="Tuesday 19 November 2024 07:04">Tuesday 19 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
&quot;Hello, revised world!&quot;</code></pre><p>As described above, the first revision you make may be very slow, but later revisions should be fast.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../config/">« Configuration</a><a class="docs-footer-nextpage" href="../limitations/">Limitations »</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="Thursday 5 December 2024 21:17">Thursday 5 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/debugging/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@
3x
end))))
Revise.LogRecord(Debug, LineOffset, Action, Revise_fb38a7f7, &quot;/home/tim/.julia/dev/Revise/src/Revise.jl&quot;, 296, (time=1.557996459391642e9, deltainfo=(Any[Tuple{typeof(unchanged),Any}], :(#= /tmp/revisetest.jl:18 =#) =&gt; :(#= /tmp/revisetest.jl:19 =#))))
Revise.LogRecord(Debug, LineOffset, Action, Revise_fb38a7f7, &quot;/home/tim/.julia/dev/Revise/src/Revise.jl&quot;, 296, (time=1.557996459391695e9, deltainfo=(Any[Tuple{typeof(unchanged2),Any}], :(#= /tmp/revisetest.jl:20 =#) =&gt; :(#= /tmp/revisetest.jl:21 =#))))</code></pre><p>You can see that Revise started by deleting three methods, followed by evaluating three new versions of those methods. Interspersed are various changes to the line numbering.</p><p>In rare cases it might be helpful to independently record the sequence of edits to the file. You can make copies <code>cp editedfile.jl &gt; /tmp/version1.jl</code>, edit code, <code>cp editedfile.jl &gt; /tmp/version2.jl</code>, etc. <code>diff version1.jl version2.jl</code> can be used to capture a compact summary of the changes and pasted into the bug report.</p><h2 id="Debugging-problems-with-paths"><a class="docs-heading-anchor" href="#Debugging-problems-with-paths">Debugging problems with paths</a><a id="Debugging-problems-with-paths-1"></a><a class="docs-heading-anchor-permalink" href="#Debugging-problems-with-paths" title="Permalink"></a></h2><p>During certain types of usage you might receive messages like</p><pre><code class="language-julia hljs">Warning: /some/system/path/stdlib/v1.0/SHA/src is not an existing directory, Revise is not watching</code></pre><p>Unless you&#39;ve just deleted that directory, this indicates that some of Revise&#39;s functionality is broken.</p><p>In the majority of cases, failures come down to Revise having trouble locating source code on your drive. This problem should be fixable, because Revise includes functionality to update its links to source files, as long as it knows what to do.</p><p>One of the best approaches is to run Revise&#39;s own tests via <code>pkg&gt; test Revise</code>. Here are some possible test warnings and errors, and steps you might take to fix them:</p><ul><li><code>Base &amp; stdlib file paths: Test Failed at /some/path... Expression: isfile(Revise.basesrccache)</code> This failure is quite serious, and indicates that you will be unable to access code in <code>Base</code>. To fix this, look for a file called <code>&quot;base.cache&quot;</code> somewhere in your Julia install or build directory (for the author, it is at <code>/home/tim/src/julia-1.0/usr/share/julia/base.cache</code>). Now compare this with the value of <code>Revise.basesrccache</code>. (If you&#39;re getting this failure, presumably they are different.) An important &quot;top level&quot; directory is <code>Sys.BINDIR</code>; if they differ already at this level, consider adding a symbolic link from the location pointed at by <code>Sys.BINDIR</code> to the corresponding top-level directory in your actual Julia installation. You&#39;ll know you&#39;ve succeeded in specifying it correctly when, after restarting Julia, <code>Revise.basesrccache</code> points to the correct file and <code>Revise.juliadir</code> points to the directory that contains <code>base/</code>. If this workaround is not possible or does not succeed, please <a href="https://github.com/timholy/Revise.jl/issues">file an issue</a> with a description of why you can&#39;t use it and/or<ul><li>details from <code>versioninfo</code> and information about how you obtained your Julia installation;</li><li>the values of <code>Revise.basesrccache</code> and <code>Revise.juliadir</code>, and the actual paths to <code>base.cache</code> and the directory containing the running Julia&#39;s <code>base/</code>;</li><li>what you attempted when trying to fix the problem;</li><li>if possible, your best understanding of why this failed to fix it.</li></ul></li><li><code>skipping Core.Compiler tests due to lack of git repo</code>: this likely indicates that you downloaded a Julia binary rather than building Julia from source. While Revise should be able to access the code in <code>Base</code> and standard libraries, at the current time it is not possible for Revise to access julia&#39;s Core.Compiler module unless you clone Julia&#39;s repository and build it from source.</li><li><code>skipping git tests because Revise is not under development</code>: this warning should be harmless. Revise has built-in functionality for extracting source code using <code>git</code>, and it uses itself (i.e., its own git repository) for testing purposes. These tests run only if you have checked out Revise for development (<code>pkg&gt; dev Revise</code>) or on the continuous integration servers (Travis and Appveyor).</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tricks/">« Tricks</a><a class="docs-footer-nextpage" href="../internals/">How Revise 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="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="Tuesday 19 November 2024 07:04">Tuesday 19 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Revise.LogRecord(Debug, LineOffset, Action, Revise_fb38a7f7, &quot;/home/tim/.julia/dev/Revise/src/Revise.jl&quot;, 296, (time=1.557996459391695e9, deltainfo=(Any[Tuple{typeof(unchanged2),Any}], :(#= /tmp/revisetest.jl:20 =#) =&gt; :(#= /tmp/revisetest.jl:21 =#))))</code></pre><p>You can see that Revise started by deleting three methods, followed by evaluating three new versions of those methods. Interspersed are various changes to the line numbering.</p><p>In rare cases it might be helpful to independently record the sequence of edits to the file. You can make copies <code>cp editedfile.jl &gt; /tmp/version1.jl</code>, edit code, <code>cp editedfile.jl &gt; /tmp/version2.jl</code>, etc. <code>diff version1.jl version2.jl</code> can be used to capture a compact summary of the changes and pasted into the bug report.</p><h2 id="Debugging-problems-with-paths"><a class="docs-heading-anchor" href="#Debugging-problems-with-paths">Debugging problems with paths</a><a id="Debugging-problems-with-paths-1"></a><a class="docs-heading-anchor-permalink" href="#Debugging-problems-with-paths" title="Permalink"></a></h2><p>During certain types of usage you might receive messages like</p><pre><code class="language-julia hljs">Warning: /some/system/path/stdlib/v1.0/SHA/src is not an existing directory, Revise is not watching</code></pre><p>Unless you&#39;ve just deleted that directory, this indicates that some of Revise&#39;s functionality is broken.</p><p>In the majority of cases, failures come down to Revise having trouble locating source code on your drive. This problem should be fixable, because Revise includes functionality to update its links to source files, as long as it knows what to do.</p><p>One of the best approaches is to run Revise&#39;s own tests via <code>pkg&gt; test Revise</code>. Here are some possible test warnings and errors, and steps you might take to fix them:</p><ul><li><code>Base &amp; stdlib file paths: Test Failed at /some/path... Expression: isfile(Revise.basesrccache)</code> This failure is quite serious, and indicates that you will be unable to access code in <code>Base</code>. To fix this, look for a file called <code>&quot;base.cache&quot;</code> somewhere in your Julia install or build directory (for the author, it is at <code>/home/tim/src/julia-1.0/usr/share/julia/base.cache</code>). Now compare this with the value of <code>Revise.basesrccache</code>. (If you&#39;re getting this failure, presumably they are different.) An important &quot;top level&quot; directory is <code>Sys.BINDIR</code>; if they differ already at this level, consider adding a symbolic link from the location pointed at by <code>Sys.BINDIR</code> to the corresponding top-level directory in your actual Julia installation. You&#39;ll know you&#39;ve succeeded in specifying it correctly when, after restarting Julia, <code>Revise.basesrccache</code> points to the correct file and <code>Revise.juliadir</code> points to the directory that contains <code>base/</code>. If this workaround is not possible or does not succeed, please <a href="https://github.com/timholy/Revise.jl/issues">file an issue</a> with a description of why you can&#39;t use it and/or<ul><li>details from <code>versioninfo</code> and information about how you obtained your Julia installation;</li><li>the values of <code>Revise.basesrccache</code> and <code>Revise.juliadir</code>, and the actual paths to <code>base.cache</code> and the directory containing the running Julia&#39;s <code>base/</code>;</li><li>what you attempted when trying to fix the problem;</li><li>if possible, your best understanding of why this failed to fix it.</li></ul></li><li><code>skipping Core.Compiler tests due to lack of git repo</code>: this likely indicates that you downloaded a Julia binary rather than building Julia from source. While Revise should be able to access the code in <code>Base</code> and standard libraries, at the current time it is not possible for Revise to access julia&#39;s Core.Compiler module unless you clone Julia&#39;s repository and build it from source.</li><li><code>skipping git tests because Revise is not under development</code>: this warning should be harmless. Revise has built-in functionality for extracting source code using <code>git</code>, and it uses itself (i.e., its own git repository) for testing purposes. These tests run only if you have checked out Revise for development (<code>pkg&gt; dev Revise</code>) or on the continuous integration servers (Travis and Appveyor).</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tricks/">« Tricks</a><a class="docs-footer-nextpage" href="../internals/">How Revise 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="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="Thursday 5 December 2024 21:17">Thursday 5 December 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
10 changes: 5 additions & 5 deletions dev/dev_reference/index.html

Large diffs are not rendered by default.

Loading

0 comments on commit c217582

Please sign in to comment.