build based on 52bac95
This commit is contained in:
zeptodoctor
parent
87b7d8963c
commit
b40427cf9e
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -1,2 +1,2 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Search · PkgTemplates.jl</title><link rel="canonical" href="https://invenia.github.io/PkgTemplates.jl/search/"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit">PkgTemplates.jl</span></div><form class="docs-search" action><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../user/">User Guide</a></li><li><a class="tocitem" href="../developer/">Developer Guide</a></li><li><a class="tocitem" href="../migrating/">Migrating To PkgTemplates 0.7+</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Search</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Search</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article><p id="documenter-search-info">Loading search...</p><ul id="documenter-search-results"></ul></article></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> on <span class="colophon-date" title="Friday 12 June 2020 00:32">Friday 12 June 2020</span>. Using Julia version 1.4.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><script src="../search_index.js"></script><script src="../assets/search.js"></script></html>
|
||||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Search · PkgTemplates.jl</title><link rel="canonical" href="https://invenia.github.io/PkgTemplates.jl/search/"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit">PkgTemplates.jl</span></div><form class="docs-search" action><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../user/">User Guide</a></li><li><a class="tocitem" href="../developer/">Developer Guide</a></li><li><a class="tocitem" href="../migrating/">Migrating To PkgTemplates 0.7+</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Search</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Search</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article><p id="documenter-search-info">Loading search...</p><ul id="documenter-search-results"></ul></article></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> on <span class="colophon-date" title="Wednesday 17 June 2020 16:34">Wednesday 17 June 2020</span>. Using Julia version 1.4.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><script src="../search_index.js"></script><script src="../assets/search.js"></script></html>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -3,19 +3,20 @@
|
||||
t = Template()
|
||||
t("MyPkg")</code></pre><h2 id="Template-1"><a class="docs-heading-anchor" href="#Template-1">Template</a><a class="docs-heading-anchor-permalink" href="#Template-1" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.Template" href="#PkgTemplates.Template"><code>PkgTemplates.Template</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Template(; kwargs...)</code></pre><p>A configuration used to generate packages.</p><p><strong>Keyword Arguments</strong></p><p><strong>User Options</strong></p><ul><li><code>user::AbstractString="username"</code>: GitHub (or other code hosting service) username. The default value comes from the global Git config (<code>github.user</code>). If no value is obtained, many plugins that use this value will not work.</li><li><code>authors::Union{AbstractString, Vector{<:AbstractString}}="name <email> and contributors"</code>: Package authors. Like <code>user</code>, it takes its default value from the global Git config (<code>user.name</code> and <code>user.email</code>).</li></ul><p><strong>Package Options</strong></p><ul><li><code>dir::AbstractString="~/.julia/dev"</code>: Directory to place packages in.</li><li><code>host::AbstractString="github.com"</code>: URL to the code hosting service where packages will reside.</li><li><code>julia::VersionNumber=v"1.0.0"</code>: Minimum allowed Julia version.</li></ul><p><strong>Template Plugins</strong></p><ul><li><code>plugins::Vector{<:Plugin}=Plugin[]</code>: A list of <a href="../developer/#PkgTemplates.Plugin"><code>Plugin</code></a>s used by the template. The default plugins are <a href="#PkgTemplates.ProjectFile"><code>ProjectFile</code></a>, <a href="#PkgTemplates.SrcDir"><code>SrcDir</code></a>, <a href="#PkgTemplates.Tests"><code>Tests</code></a>, <a href="#PkgTemplates.Readme"><code>Readme</code></a>, <a href="#PkgTemplates.License"><code>License</code></a>, <a href="#PkgTemplates.Git"><code>Git</code></a>, <a href="#PkgTemplates.CompatHelper"><code>CompatHelper</code></a>, and <a href="#PkgTemplates.TagBot"><code>TagBot</code></a>. To disable a default plugin, pass in the negated type: <code>!PluginType</code>. To override a default plugin instead of disabling it, pass in your own instance.</li></ul><p><strong>Interactive Mode</strong></p><ul><li><code>interactive::Bool=false</code>: In addition to specifying the template options with keywords, you can also build up a template by following a set of prompts. To create a template interactively, set this keyword to <code>true</code>. See also the similar <a href="#PkgTemplates.generate"><code>generate</code></a> function.</li></ul><hr/><p>To create a package from a <code>Template</code>, use the following syntax:</p><pre><code class="language-julia">julia> t = Template();
|
||||
|
||||
julia> t("PkgName")</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/970554be7fc33271669349a41c4df84e6fa8c289/src/template.jl#LL28-L71">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.generate" href="#PkgTemplates.generate"><code>PkgTemplates.generate</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">generate([pkg::AbstractString]) -> Template</code></pre><p>Shortcut for <code>Template(; interactive=true)(pkg)</code>. If no package name is supplied, you will be prompted for one.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/970554be7fc33271669349a41c4df84e6fa8c289/src/interactive.jl#LL1-L6">source</a></section></article><h2 id="Plugins-1"><a class="docs-heading-anchor" href="#Plugins-1">Plugins</a><a class="docs-heading-anchor-permalink" href="#Plugins-1" title="Permalink"></a></h2><p>Plugins add functionality to <code>Template</code>s. There are a number of plugins available to automate common boilerplate tasks.</p><h3 id="Default-Plugins-1"><a class="docs-heading-anchor" href="#Default-Plugins-1">Default Plugins</a><a class="docs-heading-anchor-permalink" href="#Default-Plugins-1" title="Permalink"></a></h3><p>These plugins are included by default. They can be overridden by supplying another value, or disabled by negating the type (<code>!Type</code>), both as elements of the <code>plugins</code> keyword.</p><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.ProjectFile" href="#PkgTemplates.ProjectFile"><code>PkgTemplates.ProjectFile</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">ProjectFile(; version=v"0.1.0")</code></pre><p>Creates a <code>Project.toml</code>.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>version::VersionNumber</code>: The initial version of created packages.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L7">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.SrcDir" href="#PkgTemplates.SrcDir"><code>PkgTemplates.SrcDir</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">SrcDir(; file="~/build/invenia/PkgTemplates.jl/templates/src/module.jl")</code></pre><p>Creates a module entrypoint.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>file::AbstractString</code>: Template file for <code>src/<module>.jl</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L7">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.Tests" href="#PkgTemplates.Tests"><code>PkgTemplates.Tests</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Tests(; file="~/build/invenia/PkgTemplates.jl/templates/test/runtests.jl", project=false)</code></pre><p>Sets up testing for packages.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>file::AbstractString</code>: Template file for <code>runtests.jl</code>.</li><li><code>project::Bool</code>: Whether or not to create a new project for tests (<code>test/Project.toml</code>). See <a href="https://julialang.github.io/Pkg.jl/v1/creating-packages/#Test-specific-dependencies-in-Julia-1.2-and-above-1">here</a> for more details.</li></ul><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Managing test dependencies with <code>test/Project.toml</code> is only supported in Julia 1.2 and later.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.Readme" href="#PkgTemplates.Readme"><code>PkgTemplates.Readme</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Readme(;
|
||||
julia> t("PkgName")</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/52bac95d66895ff9b60fd3ea1e5e37ca04847835/src/template.jl#LL28-L71">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.generate" href="#PkgTemplates.generate"><code>PkgTemplates.generate</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">generate([pkg::AbstractString]) -> Template</code></pre><p>Shortcut for <code>Template(; interactive=true)(pkg)</code>. If no package name is supplied, you will be prompted for one.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/52bac95d66895ff9b60fd3ea1e5e37ca04847835/src/interactive.jl#LL1-L6">source</a></section></article><h2 id="Plugins-1"><a class="docs-heading-anchor" href="#Plugins-1">Plugins</a><a class="docs-heading-anchor-permalink" href="#Plugins-1" title="Permalink"></a></h2><p>Plugins add functionality to <code>Template</code>s. There are a number of plugins available to automate common boilerplate tasks.</p><h3 id="Default-Plugins-1"><a class="docs-heading-anchor" href="#Default-Plugins-1">Default Plugins</a><a class="docs-heading-anchor-permalink" href="#Default-Plugins-1" title="Permalink"></a></h3><p>These plugins are included by default. They can be overridden by supplying another value, or disabled by negating the type (<code>!Type</code>), both as elements of the <code>plugins</code> keyword.</p><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.ProjectFile" href="#PkgTemplates.ProjectFile"><code>PkgTemplates.ProjectFile</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">ProjectFile(; version=v"0.1.0")</code></pre><p>Creates a <code>Project.toml</code>.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>version::VersionNumber</code>: The initial version of created packages.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L7">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.SrcDir" href="#PkgTemplates.SrcDir"><code>PkgTemplates.SrcDir</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">SrcDir(; file="~/build/invenia/PkgTemplates.jl/templates/src/module.jl")</code></pre><p>Creates a module entrypoint.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>file::AbstractString</code>: Template file for <code>src/<module>.jl</code>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L7">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.Tests" href="#PkgTemplates.Tests"><code>PkgTemplates.Tests</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Tests(; file="~/build/invenia/PkgTemplates.jl/templates/test/runtests.jl", project=false)</code></pre><p>Sets up testing for packages.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>file::AbstractString</code>: Template file for <code>runtests.jl</code>.</li><li><code>project::Bool</code>: Whether or not to create a new project for tests (<code>test/Project.toml</code>). See <a href="https://julialang.github.io/Pkg.jl/v1/creating-packages/#Test-specific-dependencies-in-Julia-1.2-and-above-1">here</a> for more details.</li></ul><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Managing test dependencies with <code>test/Project.toml</code> is only supported in Julia 1.2 and later.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.Readme" href="#PkgTemplates.Readme"><code>PkgTemplates.Readme</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Readme(;
|
||||
file="~/build/invenia/PkgTemplates.jl/templates/README.md",
|
||||
destination="README.md",
|
||||
inline_badges=false,
|
||||
)</code></pre><p>Creates a <code>README</code> file that contains badges for other included plugins.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>file::AbstractString</code>: Template file for the <code>README</code>.</li><li><code>destination::AbstractString</code>: File destination, relative to the repository root. For example, values of <code>"README"</code> or <code>"README.rst"</code> might be desired.</li><li><code>inline_badges::Bool</code>: Whether or not to put the badges on the same line as the package name.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.License" href="#PkgTemplates.License"><code>PkgTemplates.License</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">License(; name="MIT", path=nothing, destination="LICENSE")</code></pre><p>Creates a license file.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>name::AbstractString</code>: Name of a license supported by PkgTemplates. Available licenses can be seen <a href="https://github.com/invenia/PkgTemplates.jl/tree/master/templates/licenses">here</a>.</li><li><code>path::Union{AbstractString, Nothing}</code>: Path to a custom license file. This keyword takes priority over <code>name</code>.</li><li><code>destination::AbstractString</code>: File destination, relative to the repository root. For example, <code>"LICENSE.md"</code> might be desired.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/970554be7fc33271669349a41c4df84e6fa8c289/src/plugins/license.jl#LL1-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.Git" href="#PkgTemplates.Git"><code>PkgTemplates.Git</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Git(;
|
||||
)</code></pre><p>Creates a <code>README</code> file that contains badges for other included plugins.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>file::AbstractString</code>: Template file for the <code>README</code>.</li><li><code>destination::AbstractString</code>: File destination, relative to the repository root. For example, values of <code>"README"</code> or <code>"README.rst"</code> might be desired.</li><li><code>inline_badges::Bool</code>: Whether or not to put the badges on the same line as the package name.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.License" href="#PkgTemplates.License"><code>PkgTemplates.License</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">License(; name="MIT", path=nothing, destination="LICENSE")</code></pre><p>Creates a license file.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>name::AbstractString</code>: Name of a license supported by PkgTemplates. Available licenses can be seen <a href="https://github.com/invenia/PkgTemplates.jl/tree/master/templates/licenses">here</a>.</li><li><code>path::Union{AbstractString, Nothing}</code>: Path to a custom license file. This keyword takes priority over <code>name</code>.</li><li><code>destination::AbstractString</code>: File destination, relative to the repository root. For example, <code>"LICENSE.md"</code> might be desired.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/52bac95d66895ff9b60fd3ea1e5e37ca04847835/src/plugins/license.jl#LL1-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.Git" href="#PkgTemplates.Git"><code>PkgTemplates.Git</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Git(;
|
||||
ignore=String[],
|
||||
name=nothing,
|
||||
email=nothing,
|
||||
branch=nothing,
|
||||
ssh=false,
|
||||
jl=true,
|
||||
manifest=false,
|
||||
gpgsign=false,
|
||||
)</code></pre><p>Creates a Git repository and a <code>.gitignore</code> file.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>ignore::Vector{<:AbstractString}</code>: Patterns to add to the <code>.gitignore</code>. See also: <a href="../developer/#PkgTemplates.gitignore"><code>gitignore</code></a>.</li><li><code>name::AbstractString</code>: Your real name, if you have not set <code>user.name</code> with Git.</li><li><code>email::AbstractString</code>: Your email address, if you have not set <code>user.email</code> with Git.</li><li><code>ssh::Bool</code>: Whether or not to use SSH for the remote. If left unset, HTTPS is used.</li><li><code>jl::Bool</code>: Whether or not to add a <code>.jl</code> suffix to the remote URL.</li><li><code>manifest::Bool</code>: Whether or not to commit <code>Manifest.toml</code>.</li><li><code>gpgsign::Bool</code>: Whether or not to sign commits with your GPG key. This option requires that the Git CLI is installed, and for you to have a GPG key associated with your committer identity.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L25">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.CompatHelper" href="#PkgTemplates.CompatHelper"><code>PkgTemplates.CompatHelper</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">CompatHelper(;
|
||||
)</code></pre><p>Creates a Git repository and a <code>.gitignore</code> file.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>ignore::Vector{<:AbstractString}</code>: Patterns to add to the <code>.gitignore</code>. See also: <a href="../developer/#PkgTemplates.gitignore"><code>gitignore</code></a>.</li><li><code>name::AbstractString</code>: Your real name, if you have not set <code>user.name</code> with Git.</li><li><code>email::AbstractString</code>: Your email address, if you have not set <code>user.email</code> with Git.</li><li><code>branch::AbstractString</code>: The desired name of the repository's default branch.</li><li><code>ssh::Bool</code>: Whether or not to use SSH for the remote. If left unset, HTTPS is used.</li><li><code>jl::Bool</code>: Whether or not to add a <code>.jl</code> suffix to the remote URL.</li><li><code>manifest::Bool</code>: Whether or not to commit <code>Manifest.toml</code>.</li><li><code>gpgsign::Bool</code>: Whether or not to sign commits with your GPG key. This option requires that the Git CLI is installed, and for you to have a GPG key associated with your committer identity.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L27">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.CompatHelper" href="#PkgTemplates.CompatHelper"><code>PkgTemplates.CompatHelper</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">CompatHelper(;
|
||||
file="~/build/invenia/PkgTemplates.jl/templates/github/workflows/CompatHelper.yml",
|
||||
destination="CompatHelper.yml",
|
||||
cron="0 0 * * *",
|
||||
@ -34,7 +35,7 @@ julia> t("PkgName")</code></pre></div><a class="docs-sourcelink" ta
|
||||
branches=nothing,
|
||||
dispatch=nothing,
|
||||
dispatch_delay=nothing,
|
||||
)</code></pre><p>Adds GitHub release support via <a href="https://github.com/JuliaRegistries/TagBot">TagBot</a>.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>file::AbstractString</code>: Template file for the workflow file.</li><li><code>destination::AbstractString</code>: Destination of the workflow file, relative to <code>.github/workflows</code>.</li><li><code>cron::AbstractString</code>: Cron expression for the schedule interval.</li><li><code>token::Secret</code>: Name of the token secret to use.</li><li><code>ssh::Secret</code>: Name of the SSH private key secret to use.</li><li><code>ssh_password::Secret</code>: Name of the SSH key password secret to use.</li><li><code>changelog::AbstractString</code>: Custom changelog template.</li><li><code>changelog_ignore::Vector{<:AbstractString}</code>: Issue/pull request labels to ignore in the changelog.</li><li><code>gpg::Secret</code>: Name of the GPG private key secret to use.</li><li><code>gpg_password::Secret</code>: Name of the GPG private key password secret to use.</li><li><code>registry::AbstractString</code>: Custom registry, in the format <code>owner/repo</code>.</li><li><code>branches::Bool</code>: Whether not to enable the <code>branches</code> option.</li><li><code>dispatch::Bool</code>: Whether or not to enable the <code>dispatch</code> option.</li><li><code>dispatch_delay::Int</code>: Number of minutes to delay for dispatch events.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L35">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.Secret" href="#PkgTemplates.Secret"><code>PkgTemplates.Secret</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Secret(name::AbstractString)</code></pre><p>Represents a GitHub repository secret. When converted to a string, yields <code>${{ secrets.<name> }}</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/970554be7fc33271669349a41c4df84e6fa8c289/src/plugin.jl#LL87-L92">source</a></section></article><h3 id="Continuous-Integration-(CI)-1"><a class="docs-heading-anchor" href="#Continuous-Integration-(CI)-1">Continuous Integration (CI)</a><a class="docs-heading-anchor-permalink" href="#Continuous-Integration-(CI)-1" title="Permalink"></a></h3><p>These plugins will create the configuration files of common CI services for you.</p><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.AppVeyor" href="#PkgTemplates.AppVeyor"><code>PkgTemplates.AppVeyor</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">AppVeyor(;
|
||||
)</code></pre><p>Adds GitHub release support via <a href="https://github.com/JuliaRegistries/TagBot">TagBot</a>.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>file::AbstractString</code>: Template file for the workflow file.</li><li><code>destination::AbstractString</code>: Destination of the workflow file, relative to <code>.github/workflows</code>.</li><li><code>cron::AbstractString</code>: Cron expression for the schedule interval.</li><li><code>token::Secret</code>: Name of the token secret to use.</li><li><code>ssh::Secret</code>: Name of the SSH private key secret to use.</li><li><code>ssh_password::Secret</code>: Name of the SSH key password secret to use.</li><li><code>changelog::AbstractString</code>: Custom changelog template.</li><li><code>changelog_ignore::Vector{<:AbstractString}</code>: Issue/pull request labels to ignore in the changelog.</li><li><code>gpg::Secret</code>: Name of the GPG private key secret to use.</li><li><code>gpg_password::Secret</code>: Name of the GPG private key password secret to use.</li><li><code>registry::AbstractString</code>: Custom registry, in the format <code>owner/repo</code>.</li><li><code>branches::Bool</code>: Whether not to enable the <code>branches</code> option.</li><li><code>dispatch::Bool</code>: Whether or not to enable the <code>dispatch</code> option.</li><li><code>dispatch_delay::Int</code>: Number of minutes to delay for dispatch events.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L35">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.Secret" href="#PkgTemplates.Secret"><code>PkgTemplates.Secret</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Secret(name::AbstractString)</code></pre><p>Represents a GitHub repository secret. When converted to a string, yields <code>${{ secrets.<name> }}</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/52bac95d66895ff9b60fd3ea1e5e37ca04847835/src/plugin.jl#LL87-L92">source</a></section></article><h3 id="Continuous-Integration-(CI)-1"><a class="docs-heading-anchor" href="#Continuous-Integration-(CI)-1">Continuous Integration (CI)</a><a class="docs-heading-anchor-permalink" href="#Continuous-Integration-(CI)-1" title="Permalink"></a></h3><p>These plugins will create the configuration files of common CI services for you.</p><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.AppVeyor" href="#PkgTemplates.AppVeyor"><code>PkgTemplates.AppVeyor</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">AppVeyor(;
|
||||
file="~/build/invenia/PkgTemplates.jl/templates/appveyor.yml",
|
||||
x86=false,
|
||||
coverage=true,
|
||||
@ -80,7 +81,7 @@ julia> t("PkgName")</code></pre></div><a class="docs-sourcelink" ta
|
||||
assets=String[],
|
||||
canonical_url=make_canonical(T),
|
||||
makedocs_kwargs=Dict{Symbol, Any}(),
|
||||
)</code></pre><p>Sets up documentation generation via <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a>. Documentation deployment depends on <code>T</code>, where <code>T</code> is some supported CI plugin, or <code>Nothing</code> to only support local documentation builds.</p><p><strong>Supported Type Parameters</strong></p><ul><li><code>GitHubActions</code>: Deploys documentation to <a href="https://pages.github.com">GitHub Pages</a> with the help of <a href="#PkgTemplates.GitHubActions"><code>GitHubActions</code></a>.</li><li><code>TravisCI</code>: Deploys documentation to <a href="https://pages.github.com">GitHub Pages</a> with the help of <a href="#PkgTemplates.TravisCI"><code>TravisCI</code></a>.</li><li><code>GitLabCI</code>: Deploys documentation to <a href="https://pages.gitlab.com">GitLab Pages</a> with the help of <a href="#PkgTemplates.GitLabCI"><code>GitLabCI</code></a>.</li><li><code>NoDeploy</code> (default): Does not set up documentation deployment.</li></ul><p><strong>Keyword Arguments</strong></p><ul><li><code>make_jl::AbstractString</code>: Template file for <code>make.jl</code>.</li><li><code>index_md::AbstractString</code>: Template file for <code>index.md</code>.</li><li><code>assets::Vector{<:AbstractString}</code>: Extra assets for the generated site.</li><li><code>canonical_url::Union{Function, Nothing}</code>: A function to generate the site's canonical URL. The default value will compute GitHub Pages and GitLab Pages URLs for <a href="#PkgTemplates.TravisCI"><code>TravisCI</code></a> and <a href="#PkgTemplates.GitLabCI"><code>GitLabCI</code></a>, respectively. If set to <code>nothing</code>, no canonical URL is set.</li><li><code>makedocs_kwargs::Dict{Symbol}</code>: Extra keyword arguments to be inserted into <code>makedocs</code>.</li></ul><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If deploying documentation with Travis CI, don't forget to complete <a href="https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#SSH-Deploy-Keys-1">the required configuration</a>.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/970554be7fc33271669349a41c4df84e6fa8c289/src/plugins/documenter.jl#LL10-L45">source</a></section></article><h3 id="Miscellaneous-1"><a class="docs-heading-anchor" href="#Miscellaneous-1">Miscellaneous</a><a class="docs-heading-anchor-permalink" href="#Miscellaneous-1" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.Develop" href="#PkgTemplates.Develop"><code>PkgTemplates.Develop</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Develop()</code></pre><p>Adds generated packages to the current environment by <code>dev</code>ing them. See the Pkg documentation <a href="https://julialang.github.io/Pkg.jl/v1/managing-packages/#Developing-packages-1">here</a> for more details.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/970554be7fc33271669349a41c4df84e6fa8c289/src/plugins/develop.jl#LL1-L8">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.Citation" href="#PkgTemplates.Citation"><code>PkgTemplates.Citation</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Citation(; file="~/build/invenia/PkgTemplates.jl/templates/CITATION.bib", readme=false)</code></pre><p>Creates a <code>CITATION.bib</code> file for citing package repositories.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>file::AbstractString</code>: Template file for <code>CITATION.bib</code>.</li><li><code>readme::Bool</code>: Whether or not to include a section about citing in the README.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L8">source</a></section></article><h2 id="A-More-Complicated-Example-1"><a class="docs-heading-anchor" href="#A-More-Complicated-Example-1">A More Complicated Example</a><a class="docs-heading-anchor-permalink" href="#A-More-Complicated-Example-1" title="Permalink"></a></h2><p>Here are a few example templates that use the options and plugins explained above.</p><p>This one includes plugins suitable for a project hosted on GitHub, and some other customizations:</p><pre><code class="language-julia">Template(;
|
||||
)</code></pre><p>Sets up documentation generation via <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a>. Documentation deployment depends on <code>T</code>, where <code>T</code> is some supported CI plugin, or <code>Nothing</code> to only support local documentation builds.</p><p><strong>Supported Type Parameters</strong></p><ul><li><code>GitHubActions</code>: Deploys documentation to <a href="https://pages.github.com">GitHub Pages</a> with the help of <a href="#PkgTemplates.GitHubActions"><code>GitHubActions</code></a>.</li><li><code>TravisCI</code>: Deploys documentation to <a href="https://pages.github.com">GitHub Pages</a> with the help of <a href="#PkgTemplates.TravisCI"><code>TravisCI</code></a>.</li><li><code>GitLabCI</code>: Deploys documentation to <a href="https://pages.gitlab.com">GitLab Pages</a> with the help of <a href="#PkgTemplates.GitLabCI"><code>GitLabCI</code></a>.</li><li><code>NoDeploy</code> (default): Does not set up documentation deployment.</li></ul><p><strong>Keyword Arguments</strong></p><ul><li><code>make_jl::AbstractString</code>: Template file for <code>make.jl</code>.</li><li><code>index_md::AbstractString</code>: Template file for <code>index.md</code>.</li><li><code>assets::Vector{<:AbstractString}</code>: Extra assets for the generated site.</li><li><code>canonical_url::Union{Function, Nothing}</code>: A function to generate the site's canonical URL. The default value will compute GitHub Pages and GitLab Pages URLs for <a href="#PkgTemplates.TravisCI"><code>TravisCI</code></a> and <a href="#PkgTemplates.GitLabCI"><code>GitLabCI</code></a>, respectively. If set to <code>nothing</code>, no canonical URL is set.</li><li><code>makedocs_kwargs::Dict{Symbol}</code>: Extra keyword arguments to be inserted into <code>makedocs</code>.</li></ul><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If deploying documentation with Travis CI, don't forget to complete <a href="https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#SSH-Deploy-Keys-1">the required configuration</a>.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/52bac95d66895ff9b60fd3ea1e5e37ca04847835/src/plugins/documenter.jl#LL10-L45">source</a></section></article><h3 id="Miscellaneous-1"><a class="docs-heading-anchor" href="#Miscellaneous-1">Miscellaneous</a><a class="docs-heading-anchor-permalink" href="#Miscellaneous-1" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.Develop" href="#PkgTemplates.Develop"><code>PkgTemplates.Develop</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Develop()</code></pre><p>Adds generated packages to the current environment by <code>dev</code>ing them. See the Pkg documentation <a href="https://julialang.github.io/Pkg.jl/v1/managing-packages/#Developing-packages-1">here</a> for more details.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/52bac95d66895ff9b60fd3ea1e5e37ca04847835/src/plugins/develop.jl#LL1-L8">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.Citation" href="#PkgTemplates.Citation"><code>PkgTemplates.Citation</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia">Citation(; file="~/build/invenia/PkgTemplates.jl/templates/CITATION.bib", readme=false)</code></pre><p>Creates a <code>CITATION.bib</code> file for citing package repositories.</p><p><strong>Keyword Arguments</strong></p><ul><li><code>file::AbstractString</code>: Template file for <code>CITATION.bib</code>.</li><li><code>readme::Bool</code>: Whether or not to include a section about citing in the README.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L8">source</a></section></article><h2 id="A-More-Complicated-Example-1"><a class="docs-heading-anchor" href="#A-More-Complicated-Example-1">A More Complicated Example</a><a class="docs-heading-anchor-permalink" href="#A-More-Complicated-Example-1" title="Permalink"></a></h2><p>Here are a few example templates that use the options and plugins explained above.</p><p>This one includes plugins suitable for a project hosted on GitHub, and some other customizations:</p><pre><code class="language-julia">Template(;
|
||||
user="my-username",
|
||||
dir="~/code",
|
||||
authors="Acme Corp",
|
||||
@ -136,7 +137,7 @@ I have the following things:
|
||||
- Here's a thing: c
|
||||
|
||||
- John is happy
|
||||
- Jane is sad</code></pre><h2 id="Extending-Existing-Plugins-1"><a class="docs-heading-anchor" href="#Extending-Existing-Plugins-1">Extending Existing Plugins</a><a class="docs-heading-anchor-permalink" href="#Extending-Existing-Plugins-1" title="Permalink"></a></h2><p>Most of the existing plugins generate a file from a template file. If you want to use custom template files, you may run into situations where the data passed into the templating engine is not sufficient. In this case, you can look into implementing <a href="#PkgTemplates.user_view"><code>user_view</code></a> to supply whatever data is necessary for your use case.</p><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.user_view" href="#PkgTemplates.user_view"><code>PkgTemplates.user_view</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">user_view(::Plugin, ::Template, pkg::AbstractString) -> Dict{String, Any}</code></pre><p>The same as <a href="../developer/#PkgTemplates.view"><code>view</code></a>, but for use by package <em>users</em> for extension.</p><p>Values returned by this function will override those from <a href="../developer/#PkgTemplates.view"><code>view</code></a> when the keys are the same.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/970554be7fc33271669349a41c4df84e6fa8c289/src/plugin.jl#LL127-L134">source</a></section></article><p>For example, suppose you were using the <a href="#PkgTemplates.Readme"><code>Readme</code></a> plugin with a custom template file that looked like this:</p><pre><code class="language-md"># {{PKG}}
|
||||
- Jane is sad</code></pre><h2 id="Extending-Existing-Plugins-1"><a class="docs-heading-anchor" href="#Extending-Existing-Plugins-1">Extending Existing Plugins</a><a class="docs-heading-anchor-permalink" href="#Extending-Existing-Plugins-1" title="Permalink"></a></h2><p>Most of the existing plugins generate a file from a template file. If you want to use custom template files, you may run into situations where the data passed into the templating engine is not sufficient. In this case, you can look into implementing <a href="#PkgTemplates.user_view"><code>user_view</code></a> to supply whatever data is necessary for your use case.</p><article class="docstring"><header><a class="docstring-binding" id="PkgTemplates.user_view" href="#PkgTemplates.user_view"><code>PkgTemplates.user_view</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia">user_view(::Plugin, ::Template, pkg::AbstractString) -> Dict{String, Any}</code></pre><p>The same as <a href="../developer/#PkgTemplates.view"><code>view</code></a>, but for use by package <em>users</em> for extension.</p><p>Values returned by this function will override those from <a href="../developer/#PkgTemplates.view"><code>view</code></a> when the keys are the same.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/52bac95d66895ff9b60fd3ea1e5e37ca04847835/src/plugin.jl#LL127-L134">source</a></section></article><p>For example, suppose you were using the <a href="#PkgTemplates.Readme"><code>Readme</code></a> plugin with a custom template file that looked like this:</p><pre><code class="language-md"># {{PKG}}
|
||||
|
||||
Created on *{{TODAY}}*.</code></pre><p>The <a href="../developer/#PkgTemplates.view"><code>view</code></a> function supplies a value for <code>PKG</code>, but it does not supply a value for <code>TODAY</code>. Rather than override <a href="../developer/#PkgTemplates.view"><code>view</code></a>, we can implement this function to get both the default values and whatever else we need to add.</p><pre><code class="language-julia">user_view(::Readme, ::Template, ::AbstractString) = Dict("TODAY" => today())</code></pre><h2 id="Saving-Templates-1"><a class="docs-heading-anchor" href="#Saving-Templates-1">Saving Templates</a><a class="docs-heading-anchor-permalink" href="#Saving-Templates-1" title="Permalink"></a></h2><p>One of the main reasons for PkgTemplates' existence is for new packages to be consistent. This means using the same template more than once, so we want a way to save a template to be used later.</p><p>Here's my recommendation for loading a template whenever it's needed:</p><pre><code class="language-julia">function template()
|
||||
@eval using PkgTemplates
|
||||
@ -148,4 +149,4 @@ open("template.jl", "w") do io
|
||||
end</code></pre><p>Then the template is just an <code>include</code> away:</p><pre><code class="language-julia">const t = include("template.jl")</code></pre><p>The only disadvantage to this approach is that the saved template is much less human-readable than code you wrote yourself.</p><p>One more method of saving templates is to simply use the Serialization package in the standard library:</p><pre><code class="language-julia">const t = Template(; #= ... =#)
|
||||
using Serialization
|
||||
open(io -> serialize(io, t), "template.bin", "w")</code></pre><p>Then simply <code>deserialize</code> to load:</p><pre><code class="language-julia">using Serialization
|
||||
const t = open(deserialize, "template.bin")</code></pre><p>This approach has the same disadvantage as the previous one, and the serialization format is not guaranteed to be stable across Julia versions.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../developer/">Developer Guide »</a></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> on <span class="colophon-date" title="Friday 12 June 2020 00:32">Friday 12 June 2020</span>. Using Julia version 1.4.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|
||||
const t = open(deserialize, "template.bin")</code></pre><p>This approach has the same disadvantage as the previous one, and the serialization format is not guaranteed to be stable across Julia versions.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../developer/">Developer Guide »</a></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> on <span class="colophon-date" title="Wednesday 17 June 2020 16:34">Wednesday 17 June 2020</span>. Using Julia version 1.4.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user