Skip to content

Commit

Permalink
build based on 4b23121
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed May 8, 2024
1 parent 03d0c26 commit c6cfe0a
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

julia> files = ["pi.jl", "math.jl"];

julia&gt; build_notebooks(bopts, files, oopts);</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/rikhuijzer/PlutoStaticHTML.jl/blob/8509431b1edbe7a511a564177c6e0822cec98312/src/build.jl#L449-L473">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PlutoStaticHTML.BuildOptions" href="#PlutoStaticHTML.BuildOptions"><code>PlutoStaticHTML.BuildOptions</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">BuildOptions(
julia&gt; build_notebooks(bopts, files, oopts);</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/rikhuijzer/PlutoStaticHTML.jl/blob/4b2312107c7dac208778709a1112e44e5359ba2c/src/build.jl#L449-L473">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PlutoStaticHTML.BuildOptions" href="#PlutoStaticHTML.BuildOptions"><code>PlutoStaticHTML.BuildOptions</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">BuildOptions(
dir::AbstractString;
write_files::Bool=true,
previous_dir::Union{Nothing,AbstractString}=nothing,
Expand All @@ -34,7 +34,7 @@
use_distributed::Bool=true,
compiler_options::Union{Nothing,CompilerOptions}=nothing,
max_concurrent_runs::Int=4
)</code></pre><p>Arguments:</p><ul><li><code>dir</code>: Directory in which the Pluto notebooks are stored.</li><li><code>write_files</code>: Write files to <code>joinpath(dir, &quot;$file.html&quot;)</code>.</li><li><code>previous_dir::Union{Nothing,AbstractString}=Nothing</code>: Use the output from the previous run as a cache to speed up running time. To use the cache, specify a directory <code>previous_dir::AbstractString</code> which contains HTML or Markdown files from a previous run. Specifically, files are expected to be at <code>joinpath(previous_dir, &quot;$file.html&quot;)</code>. The output from the previous run may be embedded in a larger HTML or Markdown file. This package will extract the original output from the full file contents. By default, caching is disabled.</li><li><code>output_format</code>: What file to write the output to. By default this is <code>html_output::OutputFormat</code> meaning that the output of the HTML method is pure HTML. To generate Franklin, Documenter or PDF files, use respectively <code>franklin_output</code>, <code>documenter_output</code> or <code>pdf_output</code>. When <code>BuildOptions.write_files == true</code> and <code>output_format == franklin_output</code> or <code>output_format == documenter_output</code>, the output file has a &quot;.md&quot; extension instead of &quot;.html&quot;. When <code>BuildOptions.write_files == true</code> and <code>output_format == pdf_output</code>, two output files are created with &quot;.tex&quot; and &quot;.pdf&quot; extensions.</li><li><code>add_documenter_css</code> whether to add a CSS style to the HTML when <code>documenter_output=true</code>.</li><li><code>use_distributed</code>: Whether to build the notebooks in different processes. By default, this is enabled just like in Pluto and the notebooks are build in parallel. The benefit of different processes is that things are more independent of each other. Unfortunately, the drawback is that compilation has to happen for each process. By setting this option to <code>false</code>, all notebooks are built sequentially in the same process which avoids recompilation. This is likely quicker in situations where there are few threads available such as GitHub Runners depending on the notebook contents. Beware that <code>use_distributed=false</code> will <strong>not</strong> work with Pluto&#39;s built-in package manager.</li><li><code>compiler_options</code>: <code>Pluto.Configuration.CompilerOptions</code> to be passed to Pluto. This can, for example, be useful to pass custom system images from <code>PackageCompiler.jl</code>.</li><li><code>max_concurrent_runs</code>: Maximum number of notebooks to evaluate concurrently when <code>use_distributed=true</code>. Note that each notebook starts in a different process and can start multiple threads, so don&#39;t set this number too high or the CPU might be busy switching tasks and not do any productive work.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/rikhuijzer/PlutoStaticHTML.jl/blob/8509431b1edbe7a511a564177c6e0822cec98312/src/build.jl#L27-L73">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PlutoStaticHTML.OutputOptions" href="#PlutoStaticHTML.OutputOptions"><code>PlutoStaticHTML.OutputOptions</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">OutputOptions(;
)</code></pre><p>Arguments:</p><ul><li><code>dir</code>: Directory in which the Pluto notebooks are stored.</li><li><code>write_files</code>: Write files to <code>joinpath(dir, &quot;$file.html&quot;)</code>.</li><li><code>previous_dir::Union{Nothing,AbstractString}=Nothing</code>: Use the output from the previous run as a cache to speed up running time. To use the cache, specify a directory <code>previous_dir::AbstractString</code> which contains HTML or Markdown files from a previous run. Specifically, files are expected to be at <code>joinpath(previous_dir, &quot;$file.html&quot;)</code>. The output from the previous run may be embedded in a larger HTML or Markdown file. This package will extract the original output from the full file contents. By default, caching is disabled.</li><li><code>output_format</code>: What file to write the output to. By default this is <code>html_output::OutputFormat</code> meaning that the output of the HTML method is pure HTML. To generate Franklin, Documenter or PDF files, use respectively <code>franklin_output</code>, <code>documenter_output</code> or <code>pdf_output</code>. When <code>BuildOptions.write_files == true</code> and <code>output_format == franklin_output</code> or <code>output_format == documenter_output</code>, the output file has a &quot;.md&quot; extension instead of &quot;.html&quot;. When <code>BuildOptions.write_files == true</code> and <code>output_format == pdf_output</code>, two output files are created with &quot;.tex&quot; and &quot;.pdf&quot; extensions.</li><li><code>add_documenter_css</code> whether to add a CSS style to the HTML when <code>documenter_output=true</code>.</li><li><code>use_distributed</code>: Whether to build the notebooks in different processes. By default, this is enabled just like in Pluto and the notebooks are build in parallel. The benefit of different processes is that things are more independent of each other. Unfortunately, the drawback is that compilation has to happen for each process. By setting this option to <code>false</code>, all notebooks are built sequentially in the same process which avoids recompilation. This is likely quicker in situations where there are few threads available such as GitHub Runners depending on the notebook contents. Beware that <code>use_distributed=false</code> will <strong>not</strong> work with Pluto&#39;s built-in package manager.</li><li><code>compiler_options</code>: <code>Pluto.Configuration.CompilerOptions</code> to be passed to Pluto. This can, for example, be useful to pass custom system images from <code>PackageCompiler.jl</code>.</li><li><code>max_concurrent_runs</code>: Maximum number of notebooks to evaluate concurrently when <code>use_distributed=true</code>. Note that each notebook starts in a different process and can start multiple threads, so don&#39;t set this number too high or the CPU might be busy switching tasks and not do any productive work.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/rikhuijzer/PlutoStaticHTML.jl/blob/4b2312107c7dac208778709a1112e44e5359ba2c/src/build.jl#L27-L73">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PlutoStaticHTML.OutputOptions" href="#PlutoStaticHTML.OutputOptions"><code>PlutoStaticHTML.OutputOptions</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">OutputOptions(;
code_class::AbstractString=&quot;language-julia&quot;,
output_pre_class::AbstractString=&quot;code-output documenter-example-output&quot;,
hide_code::Bool=false,
Expand All @@ -45,4 +45,4 @@
show_output_above_code::Bool=false,
replace_code_tabs::Bool=true,
convert_admonitions::Bool=true
)</code></pre><p>Arguments:</p><ul><li><code>code_class</code>: HTML class for code. This is used by CSS and/or the syntax highlighter.</li><li><code>output_pre_class</code>: HTML class for <code>&lt;pre&gt;</code>.</li><li><code>output_class</code>: HTML class for output. This is used by CSS and/or the syntax highlighter.</li><li><code>hide_code</code>: Whether to omit all code blocks. Can be useful when readers are not interested in code at all.</li><li><code>hide_md_code</code>: Whether to omit all Markdown code blocks.</li><li><code>hide_md_def_code</code>: Whether to omit Franklin Markdown definition code blocks (blocks surrounded by +++).</li><li><code>add_state</code>: Whether to add a comment in HTML with the state of the input notebook. This state can be used for caching. Specifically, this state stores a checksum of the input notebook and the Julia version.</li><li><code>append_build_context</code>: Whether to append build context. When set to <code>true</code>, this adds information about the dependencies and Julia version. This is not executed via Pluto.jl&#39;s evaluation to avoid having to add extra dependencies to existing notebooks. Instead, this reads the manifest from the notebook file.</li><li><code>show_output_above_code</code>: Whether to show the output from the code above the code. Pluto.jl shows the output above the code by default; this package shows the output below the code by default. To show the output above the code, set <code>show_output_above_code=true</code>.</li><li><code>replace_code_tabs</code>: Replace tabs at the start of lines inside code blocks with spaces. This avoids inconsistent appearance of code blocks on web pages.</li><li><code>convert_admonitions</code>: Convert admonitions such as <code>!!! note This is a note.</code> from Pluto&#39;s HTML to Documenter&#39;s HTML. When this is enabled, the <code>documenter_output</code> has proper styling by default.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/rikhuijzer/PlutoStaticHTML.jl/blob/8509431b1edbe7a511a564177c6e0822cec98312/src/output.jl#L28-L83">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="notebooks/example/">Example notebook »</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 6 May 2024 10:02">Monday 6 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
)</code></pre><p>Arguments:</p><ul><li><code>code_class</code>: HTML class for code. This is used by CSS and/or the syntax highlighter.</li><li><code>output_pre_class</code>: HTML class for <code>&lt;pre&gt;</code>.</li><li><code>output_class</code>: HTML class for output. This is used by CSS and/or the syntax highlighter.</li><li><code>hide_code</code>: Whether to omit all code blocks. Can be useful when readers are not interested in code at all.</li><li><code>hide_md_code</code>: Whether to omit all Markdown code blocks.</li><li><code>hide_md_def_code</code>: Whether to omit Franklin Markdown definition code blocks (blocks surrounded by +++).</li><li><code>add_state</code>: Whether to add a comment in HTML with the state of the input notebook. This state can be used for caching. Specifically, this state stores a checksum of the input notebook and the Julia version.</li><li><code>append_build_context</code>: Whether to append build context. When set to <code>true</code>, this adds information about the dependencies and Julia version. This is not executed via Pluto.jl&#39;s evaluation to avoid having to add extra dependencies to existing notebooks. Instead, this reads the manifest from the notebook file.</li><li><code>show_output_above_code</code>: Whether to show the output from the code above the code. Pluto.jl shows the output above the code by default; this package shows the output below the code by default. To show the output above the code, set <code>show_output_above_code=true</code>.</li><li><code>replace_code_tabs</code>: Replace tabs at the start of lines inside code blocks with spaces. This avoids inconsistent appearance of code blocks on web pages.</li><li><code>convert_admonitions</code>: Convert admonitions such as <code>!!! note This is a note.</code> from Pluto&#39;s HTML to Documenter&#39;s HTML. When this is enabled, the <code>documenter_output</code> has proper styling by default.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/rikhuijzer/PlutoStaticHTML.jl/blob/4b2312107c7dac208778709a1112e44e5359ba2c/src/output.jl#L28-L83">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="notebooks/example/">Example notebook »</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="Wednesday 8 May 2024 10:23">Wednesday 8 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/notebooks/example/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ <h2 id="Admonitons"><a class="docs-heading-anchor" href="#Admonitons">Admonitons
DataFrames 1.6.1
</div>

<!-- PlutoStaticHTML.End --></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« PlutoStaticHTML</a><a class="docs-footer-nextpage" href="../../with_terminal/"><code>with_terminal</code> »</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 6 May 2024 10:02">Monday 6 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<!-- PlutoStaticHTML.End --></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« PlutoStaticHTML</a><a class="docs-footer-nextpage" href="../../with_terminal/"><code>with_terminal</code> »</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="Wednesday 8 May 2024 10:23">Wednesday 8 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit c6cfe0a

Please sign in to comment.