TastyPancakes/PkgTemplates.jl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

build based on a519916

Browse Source
This commit is contained in:
zeptodoctor 2019-05-14 23:46:40 +00:00
parent eec9f1b273
commit 2fc0f3a2c6
7 changed files with 22 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
dev/index.html
View File

@ -7,7 +7,7 @@ Template:
→ Host: github.com
→ License: MIT (Travis CI User 2019)
→ Package directory: ~/.julia/dev
→ Minimum Julia version: v1.1
→ Minimum Julia version: v1.0
→ SSH remote: No
→ Commit Manifest.toml: No
→ Plugins: None
@ -47,12 +47,12 @@ Generating project MyPkg:
[6462fe0b] - Sockets
[8dfed614] - Test
[ Info: activating new environment at ~/build/invenia/PkgTemplates.jl/docs/Project.toml.
[ Info: Committed 7 files/directories: src/, Project.toml, test/, REQUIRE, README.md, LICENSE, .gitignore
[ Info: Committed 6 files/directories: src/, Project.toml, test/, README.md, LICENSE, .gitignore
Resolving package versions...
Updating `~/build/invenia/PkgTemplates.jl/docs/Project.toml`
[ebc88c6a] + MyPkg v0.1.0 [`~/.julia/dev/MyPkg`]
[75fc1c40] + MyPkg v0.1.0 [`~/.julia/dev/MyPkg`]
Updating `~/build/invenia/PkgTemplates.jl/docs/Manifest.toml`
[ebc88c6a] + MyPkg v0.1.0 [`~/.julia/dev/MyPkg`]
[75fc1c40] + MyPkg v0.1.0 [`~/.julia/dev/MyPkg`]
[ Info: New package is at /home/travis/.julia/dev/MyPkg
julia> run(`git -C $(joinpath(t.dir, "MyPkg")) ls-files`);
@ -60,7 +60,6 @@ julia> run(`git -C $(joinpath(t.dir, "MyPkg")) ls-files`);
LICENSE
Project.toml
README.md
REQUIRE
src/MyPkg.jl
test/runtests.jl</code></pre><p>However, we can also configure a number of keyword arguments to <a href="pages/package_generation/#PkgTemplates.Template"><code>Template</code></a>:</p><pre><code class="language-julia-repl">julia&gt; using PkgTemplates
@ -112,6 +111,7 @@ Generating project MyPkg2:
[ Info: Set remote origin to git@github.com:myusername/MyPkg2.jl.git
[ Info: Created empty gh-pages branch
Resolving package versions...
[ Warning: julia version requirement for project not satisfied
Updating `~/code/MyPkg2/Project.toml`
[8dfed614] + Test
Updating `~/code/MyPkg2/Manifest.toml`
@ -127,6 +127,7 @@ Generating project MyPkg2:
Updating registry at `~/.julia/registries/General`
Updating git-repo `https://github.com/JuliaRegistries/General.git`
[?25l[?25h Resolving package versions...
[ Warning: julia version requirement for project not satisfied
Updating `~/code/MyPkg2/Project.toml`
[no changes]
Updating `~/code/MyPkg2/Manifest.toml`
@ -168,13 +169,15 @@ Generating project MyPkg2:
[cf7118a7] + UUIDs
[4ec0a83e] + Unicode
[ Info: activating new environment at ~/build/invenia/PkgTemplates.jl/docs/Project.toml.
[ Info: Committed 10 files/directories: src/, Project.toml, test/, REQUIRE, README.md, LICENSE, .appveyor.yml, docs/, .travis.yml, .gitignore
[ Info: Committed 9 files/directories: src/, Project.toml, test/, README.md, LICENSE, .travis.yml, docs/, .appveyor.yml, .gitignore
[ Info: Remember to push all created branches to your remote: git push --all
Resolving package versions...
┌ Warning: julia version requirement for package MyPkg2 not satisfied
└ @ Pkg.Operations /buildworker/worker/package_linux64/build/usr/share/julia/stdlib/v1.1/Pkg/src/Operations.jl:154
Updating `~/build/invenia/PkgTemplates.jl/docs/Project.toml`
[ee395610] + MyPkg2 v0.1.0 [`~/code/MyPkg2`]
[786cca88] + MyPkg2 v0.1.0 [`~/code/MyPkg2`]
Updating `~/build/invenia/PkgTemplates.jl/docs/Manifest.toml`
[ee395610] + MyPkg2 v0.1.0 [`~/code/MyPkg2`]
[786cca88] + MyPkg2 v0.1.0 [`~/code/MyPkg2`]
[ Info: New package is at /home/travis/code/MyPkg2
julia&gt; run(`git -C $(joinpath(t.dir, &quot;MyPkg2&quot;)) ls-files`);
@ -184,7 +187,6 @@ julia&gt; run(`git -C $(joinpath(t.dir, &quot;MyPkg2&quot;)) ls-files`);
LICENSE
Project.toml
README.md
REQUIRE
docs/Manifest.toml
docs/Project.toml
docs/make.jl

2
dev/pages/index.html
View File

File diff suppressed because one or more lines are too long

2
dev/pages/licenses/index.html
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/"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../../">Home</a></li><li><a class="toctext" href="../package_generation/">Package Generation</a></li><li><a class="toctext" href="../plugins/">Plugins</a></li><li><a class="toctext" href="../plugin_development/">Plugin Development</a></li><li class="current"><a class="toctext" href>Licenses</a><ul class="internal"></ul></li><li><a class="toctext" href="../">Index</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href>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/40c22b1a53c2a325df67f608b2beb8174ecd3005/src/licenses.jl#LL15-L19">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/40c22b1a53c2a325df67f608b2beb8174ecd3005/src/licenses.jl#LL23-L27">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="#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/40c22b1a53c2a325df67f608b2beb8174ecd3005/src/licenses.jl#LL31-L36">source</a></section><footer><hr/><a class="previous" href="../plugin_development/"><span class="direction">Previous</span><span class="title">Plugin Development</span></a><a class="next" href="../"><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/"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../../">Home</a></li><li><a class="toctext" href="../package_generation/">Package Generation</a></li><li><a class="toctext" href="../plugins/">Plugins</a></li><li><a class="toctext" href="../plugin_development/">Plugin Development</a></li><li class="current"><a class="toctext" href>Licenses</a><ul class="internal"></ul></li><li><a class="toctext" href="../">Index</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href>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/a5199164a84df37f55d59c6d1309964ed523dd34/src/licenses.jl#LL15-L19">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/a5199164a84df37f55d59c6d1309964ed523dd34/src/licenses.jl#LL23-L27">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="#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/a5199164a84df37f55d59c6d1309964ed523dd34/src/licenses.jl#LL31-L36">source</a></section><footer><hr/><a class="previous" href="../plugin_development/"><span class="direction">Previous</span><span class="title">Plugin Development</span></a><a class="next" href="../"><span class="direction">Next</span><span class="title">Index</span></a></footer></article></body></html>

4
dev/pages/package_generation/index.html
View File

File diff suppressed because one or more lines are too long

8
dev/pages/plugin_development/index.html
View File

File diff suppressed because one or more lines are too long

2
dev/pages/plugins/index.html
View File

File diff suppressed because one or more lines are too long

12
dev/search_index.js
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 (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.1.0: Minimum allowed Julia version.\nssh::Bool=false: Whether or not to use SSH for the git remote. If false HTTPS will be used.\nmanifest::Bool=false: Whether or not to commit the Manifest.toml.\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.0: Minimum allowed Julia version.\nssh::Bool=false: Whether or not to use SSH for the git remote. If false HTTPS will be used.\nmanifest::Bool=false: Whether or not to commit the Manifest.toml.\nplugins::Vector{<:Plugin}=Plugin[]: A list of Plugins that the package will include.\n\n\n\n\n\n"
},
{
@ -120,14 +120,6 @@ var documenterSearchIndex = {"docs": [
"text": "gen_tests(pkg_dir::AbstractString, t::Template) -> Vector{String}\n\nCreate the test entrypoint in pkg_dir.\n\nArguments\n\npkg_dir::AbstractString: The package directory in which the files will be generated\nt::Template: The template whose tests we are generating.\n\nReturns an array of generated file/directory names.\n\n\n\n\n\n"
},
{
"location": "pages/package_generation/#PkgTemplates.gen_require",
"page": "Package Generation",
"title": "PkgTemplates.gen_require",
"category": "function",
"text": "gen_require(pkg_dir::AbstractString, t::Template) -> Vector{String}\n\nCreate the REQUIRE file in pkg_dir.\n\nArguments\n\npkg_dir::AbstractString: The directory in which the files will be generated.\nt::Template: The template whose REQUIRE we are generating.\n\nReturns an array of generated file/directory names.\n\n\n\n\n\n"
},
{
"location": "pages/package_generation/#PkgTemplates.gen_readme",
"page": "Package Generation",
@ -157,7 +149,7 @@ var documenterSearchIndex = {"docs": [
"page": "Package Generation",
"title": "Helper Functions",
"category": "section",
"text": "gen_tests\ngen_require\ngen_readme\ngen_gitignore\ngen_license"
"text": "gen_tests\ngen_readme\ngen_gitignore\ngen_license"
},
{