diff --git a/previews/PR41/.documenter-siteinfo.json b/previews/PR41/.documenter-siteinfo.json index 12ca440..0f89645 100644 --- a/previews/PR41/.documenter-siteinfo.json +++ b/previews/PR41/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-09T20:47:05","documenter_version":"1.8.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-09T21:35:56","documenter_version":"1.8.0"}} \ No newline at end of file diff --git a/previews/PR41/index.html b/previews/PR41/index.html index ef7cecc..6119b56 100644 --- a/previews/PR41/index.html +++ b/previews/PR41/index.html @@ -1,4 +1,4 @@ Home · ITensorPkgSkeleton.jl
GitHub

ITensorPkgSkeleton.jl

Stable Dev Build Status Coverage Code Style: Blue Aqua

Installation instructions

This package resides in the ITensor/ITensorRegistry local registry. In order to install, simply add that registry through your package manager. This step is only required once.

julia> using Pkg: Pkg
 
-julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")

or:

julia> Pkg.Registry.add(url="git@github.com:ITensor/ITensorRegistry.git")

if you want to use SSH credentials, which can make it so you don't have to enter your Github ursername and password when registering packages.

Then, the package can be added as usual through the package manager:

julia> Pkg.add("ITensorPkgSkeleton")

Examples

using ITensorPkgSkeleton: ITensorPkgSkeleton

Examples go here.

This page was generated using Literate.jl.

+julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")

or:

julia> Pkg.Registry.add(url="git@github.com:ITensor/ITensorRegistry.git")

if you want to use SSH credentials, which can make it so you don't have to enter your Github ursername and password when registering packages.

Then, the package can be added as usual through the package manager:

julia> Pkg.add("ITensorPkgSkeleton")

Examples

using ITensorPkgSkeleton: ITensorPkgSkeleton

Examples go here.

This page was generated using Literate.jl.

diff --git a/previews/PR41/reference/index.html b/previews/PR41/reference/index.html index 8234d44..d17dcd0 100644 --- a/previews/PR41/reference/index.html +++ b/previews/PR41/reference/index.html @@ -24,6 +24,6 @@ julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), downstreampkgs=["ITensors", "ITensorMPS"]); -julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), downstreampkgs=[(user="ITensor", repo="ITensors")]);

Arguments

Keywords

source
ITensorPkgSkeleton.default_templates — Function
default_templates()
-

Default templates when constructing a package. Includes the following templates: ["benchmark", "docs", "downstreampkgs", "examples", "formatter", "github", "gitignore", "license", "precommit", "project", "src", "test"]

source
ITensorPkgSkeleton.all_templates — Function
all_templates()
-

All available templates when constructing a package. Includes the following templates: ["benchmark", "docs", "downstreampkgs", "examples", "formatter", "github", "gitignore", "license", "precommit", "project", "src", "test"]

source
+julia> ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir(), downstreampkgs=[(user="ITensor", repo="ITensors")]);

Arguments

Keywords

source
ITensorPkgSkeleton.default_templates — Function
default_templates()
+

Default templates when constructing a package. Includes the following templates: ["benchmark", "docs", "downstreampkgs", "examples", "formatter", "github", "gitignore", "license", "precommit", "project", "src", "test"]

source
ITensorPkgSkeleton.all_templates — Function
all_templates()
+

All available templates when constructing a package. Includes the following templates: ["benchmark", "docs", "downstreampkgs", "examples", "formatter", "github", "gitignore", "license", "precommit", "project", "src", "test"]

source