build based on 75c7875
This commit is contained in:
autodocs
parent
f989548814
commit
5356bada9e
@ -4,7 +4,7 @@
|
|||||||
julia> t = Template(; user="myusername");
|
julia> t = Template(; user="myusername");
|
||||||
|
|
||||||
julia> generate("MyPkg", t)
|
julia> generate("MyPkg", t)
|
||||||
INFO: Initialized git repo at /tmp/tmpHdlfLn/MyPkg
|
INFO: Initialized git repo at /tmp/tmpO6mUcx/MyPkg
|
||||||
INFO: Made empty initial commit
|
INFO: Made empty initial commit
|
||||||
INFO: Set remote origin to https://github.com/myusername/MyPkg.jl
|
INFO: Set remote origin to https://github.com/myusername/MyPkg.jl
|
||||||
INFO: Staged 6 files/directories: src/, test/, REQUIRE, README.md, .gitignore, LICENSE
|
INFO: Staged 6 files/directories: src/, test/, REQUIRE, README.md, .gitignore, LICENSE
|
||||||
@ -39,7 +39,7 @@ julia> t = Template(;
|
|||||||
);
|
);
|
||||||
|
|
||||||
julia> generate("MyPkg", t; force=true, ssh=true)
|
julia> generate("MyPkg", t; force=true, ssh=true)
|
||||||
INFO: Initialized git repo at /tmp/tmps07J0G/MyPkg
|
INFO: Initialized git repo at /tmp/tmpMisKBi/MyPkg
|
||||||
INFO: Applied git configuration
|
INFO: Applied git configuration
|
||||||
INFO: Made empty initial commit
|
INFO: Made empty initial commit
|
||||||
INFO: Set remote origin to git@github.com:myusername/MyPkg.jl.git
|
INFO: Set remote origin to git@github.com:myusername/MyPkg.jl.git
|
||||||
|
|||||||
@ -1,2 +1,2 @@
|
|||||||
<!DOCTYPE html>
|
<!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{line}"><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'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><pre><code class="language-none">available_licenses([io::IO]) -> Void</code></pre><p>Print the names of all available licenses.</p></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/5683495e5296888bcb7634ba0e76e763eb62da39/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><pre><code class="language-none">show_license([io::IO], license::AbstractString) -> Void</code></pre><p>Print the text of <code>license</code>. Errors if the license is not found.</p></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/5683495e5296888bcb7634ba0e76e763eb62da39/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><pre><code class="language-none">read_license(license::AbstractString) -> 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><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/5683495e5296888bcb7634ba0e76e763eb62da39/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{line}"><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'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><pre><code class="language-none">available_licenses([io::IO]) -> Void</code></pre><p>Print the names of all available licenses.</p></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/75c7875899bdab4b05600f4766e2fbc70631e1ad/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><pre><code class="language-none">show_license([io::IO], license::AbstractString) -> Void</code></pre><p>Print the text of <code>license</code>. Errors if the license is not found.</p></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/75c7875899bdab4b05600f4766e2fbc70631e1ad/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><pre><code class="language-none">read_license(license::AbstractString) -> 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><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/75c7875899bdab4b05600f4766e2fbc70631e1ad/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
@ -389,7 +389,7 @@ var documenterSearchIndex = {"docs": [
|
|||||||
"page": "Plugin Development",
|
"page": "Plugin Development",
|
||||||
"title": "PkgTemplates.substitute",
|
"title": "PkgTemplates.substitute",
|
||||||
"category": "Function",
|
"category": "Function",
|
||||||
"text": "substitute(template::AbstractString, view::Dict{String, Any}) -> String\n\nReplace placeholders in template with values in view via Mustache. template is not modified.\n\nFor information on how to structure template, see \"Defining Template Files\" section in Custom Plugins.\n\nNote: Conditionals in template without a corresponding key in view won't error, but will simply be evaluated as false.\n\n\n\nsubstitute(\n template::AbstractString,\n pkg_template::Template;\n view::Dict{String, Any}=Dict{String, Any}(),\n) -> String\n\nReplace placeholders in template, using some default replacements based on the pkg_template and additional ones in view. template is not modified.\n\n\n\n"
|
"text": "substitute(template::AbstractString, view::Dict{String, Any}) -> String\nsubstitute(\n template::AbstractString,\n pkg_template::Template;\n view::Dict{String, Any}=Dict{String, Any}(),\n) -> String\n\nReplace placeholders in template with values in view via Mustache. template is not modified. If pkg_template is supplied, some default replacements are also performed.\n\nFor information on how to structure template, see \"Defining Template Files\" section in Custom Plugins.\n\nNote: Conditionals in template without a corresponding key in view won't error, but will simply be evaluated as false.\n\n\n\n"
|
||||||
},
|
},
|
||||||
|
|
||||||
{
|
{
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user