build based on aa37584

This commit is contained in:
autodocs 2018-10-29 18:44:36 +00:00
parent ea29b65e77
commit 070cd2c0e2
18 changed files with 138 additions and 39 deletions

View File

@ -32,8 +32,24 @@ Generating project MyPkg:
[9e88b42a] + Serialization
[6462fe0b] + Sockets
[8dfed614] + Test
[ Info: Staged and committed 8 files/directories: src/, Project.toml, Manifest.toml, test/, REQUIRE, README.md, .gitignore, LICENSE
[ Info: Finished
Updating registry at `~/.julia/registries/General`
Updating git-repo `https://github.com/JuliaRegistries/General.git`
[?25l[?25h Resolving package versions...
Updating `~/.julia/dev/MyPkg/Project.toml`
[no changes]
Updating `~/.julia/dev/MyPkg/Manifest.toml`
[2a0f44e3] - Base64
[8ba89e20] - Distributed
[b77e0a4c] - InteractiveUtils
[8f399da3] - Libdl
[37e2e46d] - LinearAlgebra
[56ddb016] - Logging
[d6f4376e] - Markdown
[9a3f8284] - Random
[9e88b42a] - Serialization
[6462fe0b] - Sockets
[8dfed614] - Test
[ Info: Committed 8 files/directories: src/, Project.toml, Manifest.toml, test/, REQUIRE, README.md, .gitignore, LICENSE
julia> run(`git -C $(joinpath(t.dir, "MyPkg")) ls-files`);
.gitignore
@ -106,8 +122,24 @@ Generating project MyPkg2:
[9e88b42a] + Serialization
[6462fe0b] + Sockets
[8dfed614] + Test
[ Info: Staged and committed 11 files/directories: src/, Project.toml, Manifest.toml, test/, REQUIRE, README.md, .gitignore, LICENSE, .appveyor.yml, .travis.yml, docs/
[ Info: Finished
Updating registry at `~/.julia/registries/General`
Updating git-repo `https://github.com/JuliaRegistries/General.git`
[?25l[?25h Resolving package versions...
Updating `~/code/MyPkg2/Project.toml`
[no changes]
Updating `~/code/MyPkg2/Manifest.toml`
[2a0f44e3] - Base64
[8ba89e20] - Distributed
[b77e0a4c] - InteractiveUtils
[8f399da3] - Libdl
[37e2e46d] - LinearAlgebra
[56ddb016] - Logging
[d6f4376e] - Markdown
[9a3f8284] - Random
[9e88b42a] - Serialization
[6462fe0b] - Sockets
[8dfed614] - Test
[ Info: Committed 11 files/directories: src/, Project.toml, Manifest.toml, test/, REQUIRE, README.md, .gitignore, LICENSE, docs/, .travis.yml, .appveyor.yml
[ Info: Remember to push all created branches to your remote: git push --all
julia> run(`git -C $(joinpath(t.dir, "MyPkg2")) ls-tree -r --name-only HEAD`);

View File

@ -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>Licenses · PkgTemplates.jl</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><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/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link href="../assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>PkgTemplates.jl</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="../search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../index.html">Home</a></li><li><a class="toctext" href="package_generation.html">Package Generation</a></li><li><a class="toctext" href="plugins.html">Plugins</a></li><li><a class="toctext" href="plugin_development.html">Plugin Development</a></li><li class="current"><a class="toctext" href="licenses.html">Licenses</a><ul class="internal"></ul></li><li><a class="toctext" href="index.html">Index</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href="licenses.html">Licenses</a></li></ul><a class="edit-page" href="https://github.com/invenia/PkgTemplates.jl/blob/master/docs/src/pages/licenses.md#L"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Licenses</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Licenses-1" href="#Licenses-1">Licenses</a></h1><p><a href="https://github.com/christopher-dG/PkgTemplates.jl/tree/master/licenses">Many open-source licenses</a> are available for use with <code>PkgTemplates</code>, but if you see that one is missing, don&#39;t hesitate to open an issue or PR.</p><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.available_licenses" href="#PkgTemplates.available_licenses"><code>PkgTemplates.available_licenses</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">available_licenses([io::IO]) -&gt; Nothing</code></pre><p>Print the names of all available licenses.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/b55dc64ff1e6c149aa7485d53f66e290a8e9be2b/src/licenses.jl#LL14-L18">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.show_license" href="#PkgTemplates.show_license"><code>PkgTemplates.show_license</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">show_license([io::IO], license::AbstractString) -&gt; Nothing</code></pre><p>Print the text of <code>license</code>. Errors if the license is not found.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/b55dc64ff1e6c149aa7485d53f66e290a8e9be2b/src/licenses.jl#LL22-L26">source</a></section><h3><a class="nav-anchor" id="Helper-Functions-1" href="#Helper-Functions-1">Helper Functions</a></h3><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.read_license" href="#PkgTemplates.read_license"><code>PkgTemplates.read_license</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">read_license(license::AbstractString) -&gt; String</code></pre><p>Returns the contents of <code>license</code>. Errors if the license is not found. Use <a href="licenses.html#PkgTemplates.available_licenses"><code>available_licenses</code></a> to view available licenses.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/b55dc64ff1e6c149aa7485d53f66e290a8e9be2b/src/licenses.jl#LL30-L35">source</a></section><footer><hr/><a class="previous" href="plugin_development.html"><span class="direction">Previous</span><span class="title">Plugin Development</span></a><a class="next" href="index.html"><span class="direction">Next</span><span class="title">Index</span></a></footer></article></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Licenses · PkgTemplates.jl</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><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/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link href="../assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>PkgTemplates.jl</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="../search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../index.html">Home</a></li><li><a class="toctext" href="package_generation.html">Package Generation</a></li><li><a class="toctext" href="plugins.html">Plugins</a></li><li><a class="toctext" href="plugin_development.html">Plugin Development</a></li><li class="current"><a class="toctext" href="licenses.html">Licenses</a><ul class="internal"></ul></li><li><a class="toctext" href="index.html">Index</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href="licenses.html">Licenses</a></li></ul><a class="edit-page" href="https://github.com/invenia/PkgTemplates.jl/blob/master/docs/src/pages/licenses.md#L"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Licenses</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Licenses-1" href="#Licenses-1">Licenses</a></h1><p><a href="https://github.com/christopher-dG/PkgTemplates.jl/tree/master/licenses">Many open-source licenses</a> are available for use with <code>PkgTemplates</code>, but if you see that one is missing, don&#39;t hesitate to open an issue or PR.</p><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.available_licenses" href="#PkgTemplates.available_licenses"><code>PkgTemplates.available_licenses</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">available_licenses([io::IO]) -&gt; Nothing</code></pre><p>Print the names of all available licenses.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/aa3758476a185404434420a49b966952630dc32d/src/licenses.jl#LL14-L18">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.show_license" href="#PkgTemplates.show_license"><code>PkgTemplates.show_license</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">show_license([io::IO], license::AbstractString) -&gt; Nothing</code></pre><p>Print the text of <code>license</code>. Errors if the license is not found.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/aa3758476a185404434420a49b966952630dc32d/src/licenses.jl#LL22-L26">source</a></section><h3><a class="nav-anchor" id="Helper-Functions-1" href="#Helper-Functions-1">Helper Functions</a></h3><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.read_license" href="#PkgTemplates.read_license"><code>PkgTemplates.read_license</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">read_license(license::AbstractString) -&gt; String</code></pre><p>Returns the contents of <code>license</code>. Errors if the license is not found. Use <a href="licenses.html#PkgTemplates.available_licenses"><code>available_licenses</code></a> to view available licenses.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/aa3758476a185404434420a49b966952630dc32d/src/licenses.jl#LL30-L35">source</a></section><footer><hr/><a class="previous" href="plugin_development.html"><span class="direction">Previous</span><span class="title">Plugin Development</span></a><a class="next" href="index.html"><span class="direction">Next</span><span class="title">Index</span></a></footer></article></body></html>

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

View File

@ -69,7 +69,7 @@ var documenterSearchIndex = {"docs": [
"page": "Package Generation",
"title": "PkgTemplates.Template",
"category": "type",
"text": "Template(; kwargs...) -> Template\n\nRecords common information used to generate a package. If you don\'t wish to manually create a template, you can use interactive_template instead.\n\nKeyword Arguments\n\nuser::AbstractString=\"\": GitHub (or other code hosting service) username. If left unset, it will take the the global git config\'s value. If that is not set, an ArgumentError is thrown. This is case-sensitive for some plugins, so take care to enter it correctly.\nhost::AbstractString=\"github.com\": URL to the code hosting service where your package will reside. Note that while hosts other than GitHub won\'t cause errors, they are not officially supported and they will cause certain plugins will produce incorrect output.\nlicense::AbstractString=\"MIT\": Name of the package license. If an empty string is given, no license is created. available_licenses can be used to list all available licenses, and show_license can be used to print out a particular license\'s text.\nauthors::Union{AbstractString, Vector{<:AbstractString}}=\"\": Names that appear on the license. Supply a string for one author or an array for multiple. Similarly to user, it will take the value of of the global git config\'s value if it is left unset.\ndir::AbstractString=/home/travis/.julia/dev: Directory in which the package will go. Relative paths are converted to absolute ones at template creation time.\njulia_version::VersionNumber=VERSION: Minimum allowed Julia version.\nssh::Bool=false: Whether or not to use SSH for the remote.\nplugins::Vector{<:Plugin}=Plugin[]: A list of Plugins that the package will include.\n\n\n\n\n\n"
"text": "Template(; kwargs...) -> Template\n\nRecords common information used to generate a package. If you don\'t wish to manually create a template, you can use interactive_template instead.\n\nKeyword Arguments\n\nuser::AbstractString=\"\": GitHub (or other code hosting service) username. If left unset, it will take the the global git config\'s value (github.user). If that is not set, an ArgumentError is thrown. This is case-sensitive for some plugins, so take care to enter it correctly.\nhost::AbstractString=\"github.com\": URL to the code hosting service where your package will reside. Note that while hosts other than GitHub won\'t cause errors, they are not officially supported and they will cause certain plugins will produce incorrect output.\nlicense::AbstractString=\"MIT\": Name of the package license. If an empty string is given, no license is created. available_licenses can be used to list all available licenses, and show_license can be used to print out a particular license\'s text.\nauthors::Union{AbstractString, Vector{<:AbstractString}}=\"\": Names that appear on the license. Supply a string for one author or an array for multiple. Similarly to user, it will take the value of of the global git config\'s value if it is left unset.\ndir::AbstractString=~/.julia/dev: Directory in which the package will go. Relative paths are converted to absolute ones at template creation time.\njulia_version::VersionNumber=1.0.1: Minimum allowed Julia version.\nssh::Bool=false: Whether or not to use SSH for the remote.\nplugins::Vector{<:Plugin}=Plugin[]: A list of Plugins that the package will include.\n\n\n\n\n\n"
},
{
@ -93,7 +93,7 @@ var documenterSearchIndex = {"docs": [
"page": "Package Generation",
"title": "PkgTemplates.generate",
"category": "function",
"text": "generate(pkg_name::AbstractString, t::Template) -> Nothing\n\nGenerate a package named pkg_name from t.\n\n\n\n\n\n"
"text": "generate(pkg::AbstractString, t::Template) -> Nothing\ngenerate(t::Template, pkg::AbstractString) -> Nothing\n\nGenerate a package named pkg from t.\n\n\n\n\n\n"
},
{

View File

@ -32,8 +32,24 @@ Generating project MyPkg:
[9e88b42a] + Serialization
[6462fe0b] + Sockets
[8dfed614] + Test
[ Info: Staged and committed 8 files/directories: src/, Project.toml, Manifest.toml, test/, REQUIRE, README.md, .gitignore, LICENSE
[ Info: Finished
Updating registry at `~/.julia/registries/General`
Updating git-repo `https://github.com/JuliaRegistries/General.git`
[?25l[?25h Resolving package versions...
Updating `~/.julia/dev/MyPkg/Project.toml`
[no changes]
Updating `~/.julia/dev/MyPkg/Manifest.toml`
[2a0f44e3] - Base64
[8ba89e20] - Distributed
[b77e0a4c] - InteractiveUtils
[8f399da3] - Libdl
[37e2e46d] - LinearAlgebra
[56ddb016] - Logging
[d6f4376e] - Markdown
[9a3f8284] - Random
[9e88b42a] - Serialization
[6462fe0b] - Sockets
[8dfed614] - Test
[ Info: Committed 8 files/directories: src/, Project.toml, Manifest.toml, test/, REQUIRE, README.md, .gitignore, LICENSE
julia&gt; run(`git -C $(joinpath(t.dir, &quot;MyPkg&quot;)) ls-files`);
.gitignore
@ -106,8 +122,24 @@ Generating project MyPkg2:
[9e88b42a] + Serialization
[6462fe0b] + Sockets
[8dfed614] + Test
[ Info: Staged and committed 11 files/directories: src/, Project.toml, Manifest.toml, test/, REQUIRE, README.md, .gitignore, LICENSE, .appveyor.yml, .travis.yml, docs/
[ Info: Finished
Updating registry at `~/.julia/registries/General`
Updating git-repo `https://github.com/JuliaRegistries/General.git`
[?25l[?25h Resolving package versions...
Updating `~/code/MyPkg2/Project.toml`
[no changes]
Updating `~/code/MyPkg2/Manifest.toml`
[2a0f44e3] - Base64
[8ba89e20] - Distributed
[b77e0a4c] - InteractiveUtils
[8f399da3] - Libdl
[37e2e46d] - LinearAlgebra
[56ddb016] - Logging
[d6f4376e] - Markdown
[9a3f8284] - Random
[9e88b42a] - Serialization
[6462fe0b] - Sockets
[8dfed614] - Test
[ Info: Committed 11 files/directories: src/, Project.toml, Manifest.toml, test/, REQUIRE, README.md, .gitignore, LICENSE, docs/, .travis.yml, .appveyor.yml
[ Info: Remember to push all created branches to your remote: git push --all
julia&gt; run(`git -C $(joinpath(t.dir, &quot;MyPkg2&quot;)) ls-tree -r --name-only HEAD`);

View File

@ -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>Licenses · PkgTemplates.jl</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><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/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link href="../assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>PkgTemplates.jl</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="../search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../index.html">Home</a></li><li><a class="toctext" href="package_generation.html">Package Generation</a></li><li><a class="toctext" href="plugins.html">Plugins</a></li><li><a class="toctext" href="plugin_development.html">Plugin Development</a></li><li class="current"><a class="toctext" href="licenses.html">Licenses</a><ul class="internal"></ul></li><li><a class="toctext" href="index.html">Index</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href="licenses.html">Licenses</a></li></ul><a class="edit-page" href="https://github.com/invenia/PkgTemplates.jl/blob/master/docs/src/pages/licenses.md#L"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Licenses</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Licenses-1" href="#Licenses-1">Licenses</a></h1><p><a href="https://github.com/christopher-dG/PkgTemplates.jl/tree/master/licenses">Many open-source licenses</a> are available for use with <code>PkgTemplates</code>, but if you see that one is missing, don&#39;t hesitate to open an issue or PR.</p><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.available_licenses" href="#PkgTemplates.available_licenses"><code>PkgTemplates.available_licenses</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">available_licenses([io::IO]) -&gt; Nothing</code></pre><p>Print the names of all available licenses.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/b55dc64ff1e6c149aa7485d53f66e290a8e9be2b/src/licenses.jl#LL14-L18">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.show_license" href="#PkgTemplates.show_license"><code>PkgTemplates.show_license</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">show_license([io::IO], license::AbstractString) -&gt; Nothing</code></pre><p>Print the text of <code>license</code>. Errors if the license is not found.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/b55dc64ff1e6c149aa7485d53f66e290a8e9be2b/src/licenses.jl#LL22-L26">source</a></section><h3><a class="nav-anchor" id="Helper-Functions-1" href="#Helper-Functions-1">Helper Functions</a></h3><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.read_license" href="#PkgTemplates.read_license"><code>PkgTemplates.read_license</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">read_license(license::AbstractString) -&gt; String</code></pre><p>Returns the contents of <code>license</code>. Errors if the license is not found. Use <a href="licenses.html#PkgTemplates.available_licenses"><code>available_licenses</code></a> to view available licenses.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/b55dc64ff1e6c149aa7485d53f66e290a8e9be2b/src/licenses.jl#LL30-L35">source</a></section><footer><hr/><a class="previous" href="plugin_development.html"><span class="direction">Previous</span><span class="title">Plugin Development</span></a><a class="next" href="index.html"><span class="direction">Next</span><span class="title">Index</span></a></footer></article></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Licenses · PkgTemplates.jl</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><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/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link href="../assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>PkgTemplates.jl</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="../search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../index.html">Home</a></li><li><a class="toctext" href="package_generation.html">Package Generation</a></li><li><a class="toctext" href="plugins.html">Plugins</a></li><li><a class="toctext" href="plugin_development.html">Plugin Development</a></li><li class="current"><a class="toctext" href="licenses.html">Licenses</a><ul class="internal"></ul></li><li><a class="toctext" href="index.html">Index</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href="licenses.html">Licenses</a></li></ul><a class="edit-page" href="https://github.com/invenia/PkgTemplates.jl/blob/master/docs/src/pages/licenses.md#L"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Licenses</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Licenses-1" href="#Licenses-1">Licenses</a></h1><p><a href="https://github.com/christopher-dG/PkgTemplates.jl/tree/master/licenses">Many open-source licenses</a> are available for use with <code>PkgTemplates</code>, but if you see that one is missing, don&#39;t hesitate to open an issue or PR.</p><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.available_licenses" href="#PkgTemplates.available_licenses"><code>PkgTemplates.available_licenses</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">available_licenses([io::IO]) -&gt; Nothing</code></pre><p>Print the names of all available licenses.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/aa3758476a185404434420a49b966952630dc32d/src/licenses.jl#LL14-L18">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.show_license" href="#PkgTemplates.show_license"><code>PkgTemplates.show_license</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">show_license([io::IO], license::AbstractString) -&gt; Nothing</code></pre><p>Print the text of <code>license</code>. Errors if the license is not found.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/aa3758476a185404434420a49b966952630dc32d/src/licenses.jl#LL22-L26">source</a></section><h3><a class="nav-anchor" id="Helper-Functions-1" href="#Helper-Functions-1">Helper Functions</a></h3><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.read_license" href="#PkgTemplates.read_license"><code>PkgTemplates.read_license</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">read_license(license::AbstractString) -&gt; String</code></pre><p>Returns the contents of <code>license</code>. Errors if the license is not found. Use <a href="licenses.html#PkgTemplates.available_licenses"><code>available_licenses</code></a> to view available licenses.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/aa3758476a185404434420a49b966952630dc32d/src/licenses.jl#LL30-L35">source</a></section><footer><hr/><a class="previous" href="plugin_development.html"><span class="direction">Previous</span><span class="title">Plugin Development</span></a><a class="next" href="index.html"><span class="direction">Next</span><span class="title">Index</span></a></footer></article></body></html>

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

View File

@ -69,7 +69,7 @@ var documenterSearchIndex = {"docs": [
"page": "Package Generation",
"title": "PkgTemplates.Template",
"category": "type",
"text": "Template(; kwargs...) -> Template\n\nRecords common information used to generate a package. If you don\'t wish to manually create a template, you can use interactive_template instead.\n\nKeyword Arguments\n\nuser::AbstractString=\"\": GitHub (or other code hosting service) username. If left unset, it will take the the global git config\'s value. If that is not set, an ArgumentError is thrown. This is case-sensitive for some plugins, so take care to enter it correctly.\nhost::AbstractString=\"github.com\": URL to the code hosting service where your package will reside. Note that while hosts other than GitHub won\'t cause errors, they are not officially supported and they will cause certain plugins will produce incorrect output.\nlicense::AbstractString=\"MIT\": Name of the package license. If an empty string is given, no license is created. available_licenses can be used to list all available licenses, and show_license can be used to print out a particular license\'s text.\nauthors::Union{AbstractString, Vector{<:AbstractString}}=\"\": Names that appear on the license. Supply a string for one author or an array for multiple. Similarly to user, it will take the value of of the global git config\'s value if it is left unset.\ndir::AbstractString=/home/travis/.julia/dev: Directory in which the package will go. Relative paths are converted to absolute ones at template creation time.\njulia_version::VersionNumber=VERSION: Minimum allowed Julia version.\nssh::Bool=false: Whether or not to use SSH for the remote.\nplugins::Vector{<:Plugin}=Plugin[]: A list of Plugins that the package will include.\n\n\n\n\n\n"
"text": "Template(; kwargs...) -> Template\n\nRecords common information used to generate a package. If you don\'t wish to manually create a template, you can use interactive_template instead.\n\nKeyword Arguments\n\nuser::AbstractString=\"\": GitHub (or other code hosting service) username. If left unset, it will take the the global git config\'s value (github.user). If that is not set, an ArgumentError is thrown. This is case-sensitive for some plugins, so take care to enter it correctly.\nhost::AbstractString=\"github.com\": URL to the code hosting service where your package will reside. Note that while hosts other than GitHub won\'t cause errors, they are not officially supported and they will cause certain plugins will produce incorrect output.\nlicense::AbstractString=\"MIT\": Name of the package license. If an empty string is given, no license is created. available_licenses can be used to list all available licenses, and show_license can be used to print out a particular license\'s text.\nauthors::Union{AbstractString, Vector{<:AbstractString}}=\"\": Names that appear on the license. Supply a string for one author or an array for multiple. Similarly to user, it will take the value of of the global git config\'s value if it is left unset.\ndir::AbstractString=~/.julia/dev: Directory in which the package will go. Relative paths are converted to absolute ones at template creation time.\njulia_version::VersionNumber=1.0.1: Minimum allowed Julia version.\nssh::Bool=false: Whether or not to use SSH for the remote.\nplugins::Vector{<:Plugin}=Plugin[]: A list of Plugins that the package will include.\n\n\n\n\n\n"
},
{
@ -93,7 +93,7 @@ var documenterSearchIndex = {"docs": [
"page": "Package Generation",
"title": "PkgTemplates.generate",
"category": "function",
"text": "generate(pkg_name::AbstractString, t::Template) -> Nothing\n\nGenerate a package named pkg_name from t.\n\n\n\n\n\n"
"text": "generate(pkg::AbstractString, t::Template) -> Nothing\ngenerate(t::Template, pkg::AbstractString) -> Nothing\n\nGenerate a package named pkg from t.\n\n\n\n\n\n"
},
{

View File

@ -32,8 +32,24 @@ Generating project MyPkg:
[9e88b42a] + Serialization
[6462fe0b] + Sockets
[8dfed614] + Test
[ Info: Staged and committed 8 files/directories: src/, Project.toml, Manifest.toml, test/, REQUIRE, README.md, .gitignore, LICENSE
[ Info: Finished
Updating registry at `~/.julia/registries/General`
Updating git-repo `https://github.com/JuliaRegistries/General.git`
[?25l[?25h Resolving package versions...
Updating `~/.julia/dev/MyPkg/Project.toml`
[no changes]
Updating `~/.julia/dev/MyPkg/Manifest.toml`
[2a0f44e3] - Base64
[8ba89e20] - Distributed
[b77e0a4c] - InteractiveUtils
[8f399da3] - Libdl
[37e2e46d] - LinearAlgebra
[56ddb016] - Logging
[d6f4376e] - Markdown
[9a3f8284] - Random
[9e88b42a] - Serialization
[6462fe0b] - Sockets
[8dfed614] - Test
[ Info: Committed 8 files/directories: src/, Project.toml, Manifest.toml, test/, REQUIRE, README.md, .gitignore, LICENSE
julia&gt; run(`git -C $(joinpath(t.dir, &quot;MyPkg&quot;)) ls-files`);
.gitignore
@ -106,8 +122,24 @@ Generating project MyPkg2:
[9e88b42a] + Serialization
[6462fe0b] + Sockets
[8dfed614] + Test
[ Info: Staged and committed 11 files/directories: src/, Project.toml, Manifest.toml, test/, REQUIRE, README.md, .gitignore, LICENSE, .appveyor.yml, .travis.yml, docs/
[ Info: Finished
Updating registry at `~/.julia/registries/General`
Updating git-repo `https://github.com/JuliaRegistries/General.git`
[?25l[?25h Resolving package versions...
Updating `~/code/MyPkg2/Project.toml`
[no changes]
Updating `~/code/MyPkg2/Manifest.toml`
[2a0f44e3] - Base64
[8ba89e20] - Distributed
[b77e0a4c] - InteractiveUtils
[8f399da3] - Libdl
[37e2e46d] - LinearAlgebra
[56ddb016] - Logging
[d6f4376e] - Markdown
[9a3f8284] - Random
[9e88b42a] - Serialization
[6462fe0b] - Sockets
[8dfed614] - Test
[ Info: Committed 11 files/directories: src/, Project.toml, Manifest.toml, test/, REQUIRE, README.md, .gitignore, LICENSE, docs/, .travis.yml, .appveyor.yml
[ Info: Remember to push all created branches to your remote: git push --all
julia&gt; run(`git -C $(joinpath(t.dir, &quot;MyPkg2&quot;)) ls-tree -r --name-only HEAD`);

View File

@ -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>Licenses · PkgTemplates.jl</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><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/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link href="../assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>PkgTemplates.jl</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="../search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../index.html">Home</a></li><li><a class="toctext" href="package_generation.html">Package Generation</a></li><li><a class="toctext" href="plugins.html">Plugins</a></li><li><a class="toctext" href="plugin_development.html">Plugin Development</a></li><li class="current"><a class="toctext" href="licenses.html">Licenses</a><ul class="internal"></ul></li><li><a class="toctext" href="index.html">Index</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href="licenses.html">Licenses</a></li></ul><a class="edit-page" href="https://github.com/invenia/PkgTemplates.jl/blob/master/docs/src/pages/licenses.md#L"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Licenses</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Licenses-1" href="#Licenses-1">Licenses</a></h1><p><a href="https://github.com/christopher-dG/PkgTemplates.jl/tree/master/licenses">Many open-source licenses</a> are available for use with <code>PkgTemplates</code>, but if you see that one is missing, don&#39;t hesitate to open an issue or PR.</p><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.available_licenses" href="#PkgTemplates.available_licenses"><code>PkgTemplates.available_licenses</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">available_licenses([io::IO]) -&gt; Nothing</code></pre><p>Print the names of all available licenses.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/b55dc64ff1e6c149aa7485d53f66e290a8e9be2b/src/licenses.jl#LL14-L18">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.show_license" href="#PkgTemplates.show_license"><code>PkgTemplates.show_license</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">show_license([io::IO], license::AbstractString) -&gt; Nothing</code></pre><p>Print the text of <code>license</code>. Errors if the license is not found.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/b55dc64ff1e6c149aa7485d53f66e290a8e9be2b/src/licenses.jl#LL22-L26">source</a></section><h3><a class="nav-anchor" id="Helper-Functions-1" href="#Helper-Functions-1">Helper Functions</a></h3><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.read_license" href="#PkgTemplates.read_license"><code>PkgTemplates.read_license</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">read_license(license::AbstractString) -&gt; String</code></pre><p>Returns the contents of <code>license</code>. Errors if the license is not found. Use <a href="licenses.html#PkgTemplates.available_licenses"><code>available_licenses</code></a> to view available licenses.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/b55dc64ff1e6c149aa7485d53f66e290a8e9be2b/src/licenses.jl#LL30-L35">source</a></section><footer><hr/><a class="previous" href="plugin_development.html"><span class="direction">Previous</span><span class="title">Plugin Development</span></a><a class="next" href="index.html"><span class="direction">Next</span><span class="title">Index</span></a></footer></article></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Licenses · PkgTemplates.jl</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><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/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link href="../assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>PkgTemplates.jl</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="../search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../index.html">Home</a></li><li><a class="toctext" href="package_generation.html">Package Generation</a></li><li><a class="toctext" href="plugins.html">Plugins</a></li><li><a class="toctext" href="plugin_development.html">Plugin Development</a></li><li class="current"><a class="toctext" href="licenses.html">Licenses</a><ul class="internal"></ul></li><li><a class="toctext" href="index.html">Index</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href="licenses.html">Licenses</a></li></ul><a class="edit-page" href="https://github.com/invenia/PkgTemplates.jl/blob/master/docs/src/pages/licenses.md#L"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Licenses</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Licenses-1" href="#Licenses-1">Licenses</a></h1><p><a href="https://github.com/christopher-dG/PkgTemplates.jl/tree/master/licenses">Many open-source licenses</a> are available for use with <code>PkgTemplates</code>, but if you see that one is missing, don&#39;t hesitate to open an issue or PR.</p><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.available_licenses" href="#PkgTemplates.available_licenses"><code>PkgTemplates.available_licenses</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">available_licenses([io::IO]) -&gt; Nothing</code></pre><p>Print the names of all available licenses.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/aa3758476a185404434420a49b966952630dc32d/src/licenses.jl#LL14-L18">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.show_license" href="#PkgTemplates.show_license"><code>PkgTemplates.show_license</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">show_license([io::IO], license::AbstractString) -&gt; Nothing</code></pre><p>Print the text of <code>license</code>. Errors if the license is not found.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/aa3758476a185404434420a49b966952630dc32d/src/licenses.jl#LL22-L26">source</a></section><h3><a class="nav-anchor" id="Helper-Functions-1" href="#Helper-Functions-1">Helper Functions</a></h3><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.read_license" href="#PkgTemplates.read_license"><code>PkgTemplates.read_license</code></a><span class="docstring-category">Function</span>.</div><div><div><pre><code class="language-none">read_license(license::AbstractString) -&gt; String</code></pre><p>Returns the contents of <code>license</code>. Errors if the license is not found. Use <a href="licenses.html#PkgTemplates.available_licenses"><code>available_licenses</code></a> to view available licenses.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/aa3758476a185404434420a49b966952630dc32d/src/licenses.jl#LL30-L35">source</a></section><footer><hr/><a class="previous" href="plugin_development.html"><span class="direction">Previous</span><span class="title">Plugin Development</span></a><a class="next" href="index.html"><span class="direction">Next</span><span class="title">Index</span></a></footer></article></body></html>

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

View File

@ -69,7 +69,7 @@ var documenterSearchIndex = {"docs": [
"page": "Package Generation",
"title": "PkgTemplates.Template",
"category": "type",
"text": "Template(; kwargs...) -> Template\n\nRecords common information used to generate a package. If you don\'t wish to manually create a template, you can use interactive_template instead.\n\nKeyword Arguments\n\nuser::AbstractString=\"\": GitHub (or other code hosting service) username. If left unset, it will take the the global git config\'s value. If that is not set, an ArgumentError is thrown. This is case-sensitive for some plugins, so take care to enter it correctly.\nhost::AbstractString=\"github.com\": URL to the code hosting service where your package will reside. Note that while hosts other than GitHub won\'t cause errors, they are not officially supported and they will cause certain plugins will produce incorrect output.\nlicense::AbstractString=\"MIT\": Name of the package license. If an empty string is given, no license is created. available_licenses can be used to list all available licenses, and show_license can be used to print out a particular license\'s text.\nauthors::Union{AbstractString, Vector{<:AbstractString}}=\"\": Names that appear on the license. Supply a string for one author or an array for multiple. Similarly to user, it will take the value of of the global git config\'s value if it is left unset.\ndir::AbstractString=/home/travis/.julia/dev: Directory in which the package will go. Relative paths are converted to absolute ones at template creation time.\njulia_version::VersionNumber=VERSION: Minimum allowed Julia version.\nssh::Bool=false: Whether or not to use SSH for the remote.\nplugins::Vector{<:Plugin}=Plugin[]: A list of Plugins that the package will include.\n\n\n\n\n\n"
"text": "Template(; kwargs...) -> Template\n\nRecords common information used to generate a package. If you don\'t wish to manually create a template, you can use interactive_template instead.\n\nKeyword Arguments\n\nuser::AbstractString=\"\": GitHub (or other code hosting service) username. If left unset, it will take the the global git config\'s value (github.user). If that is not set, an ArgumentError is thrown. This is case-sensitive for some plugins, so take care to enter it correctly.\nhost::AbstractString=\"github.com\": URL to the code hosting service where your package will reside. Note that while hosts other than GitHub won\'t cause errors, they are not officially supported and they will cause certain plugins will produce incorrect output.\nlicense::AbstractString=\"MIT\": Name of the package license. If an empty string is given, no license is created. available_licenses can be used to list all available licenses, and show_license can be used to print out a particular license\'s text.\nauthors::Union{AbstractString, Vector{<:AbstractString}}=\"\": Names that appear on the license. Supply a string for one author or an array for multiple. Similarly to user, it will take the value of of the global git config\'s value if it is left unset.\ndir::AbstractString=~/.julia/dev: Directory in which the package will go. Relative paths are converted to absolute ones at template creation time.\njulia_version::VersionNumber=1.0.1: Minimum allowed Julia version.\nssh::Bool=false: Whether or not to use SSH for the remote.\nplugins::Vector{<:Plugin}=Plugin[]: A list of Plugins that the package will include.\n\n\n\n\n\n"
},
{
@ -93,7 +93,7 @@ var documenterSearchIndex = {"docs": [
"page": "Package Generation",
"title": "PkgTemplates.generate",
"category": "function",
"text": "generate(pkg_name::AbstractString, t::Template) -> Nothing\n\nGenerate a package named pkg_name from t.\n\n\n\n\n\n"
"text": "generate(pkg::AbstractString, t::Template) -> Nothing\ngenerate(t::Template, pkg::AbstractString) -> Nothing\n\nGenerate a package named pkg from t.\n\n\n\n\n\n"
},
{