diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index b98bc78..ecafbad 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-22T22:11:18","documenter_version":"1.8.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-23T13:29:20","documenter_version":"1.8.0"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index 8eed21a..ad2b11f 100644 --- a/dev/index.html +++ b/dev/index.html @@ -3,7 +3,7 @@ julia> Pkg.add("https://github.com/ITensor/ITensorPkgSkeleton.jl")

Examples

using ITensorPkgSkeleton: ITensorPkgSkeleton

This step might be required to circumvent issues with the version of git installed by Git.jl.

ITensorPkgSkeleton.use_system_git!()

If path isn't specified, it defaults to ~/.julia/dev.

ITensorPkgSkeleton.generate("NewPkg"; path=mktempdir())
getting template replacement values
 reading template /home/runner/work/ITensorPkgSkeleton.jl/ITensorPkgSkeleton.jl/templates/default from /home/runner/work/ITensorPkgSkeleton.jl/ITensorPkgSkeleton.jl/templates/default
-target /tmp/jl_ozRmjv/NewPkg does not exist, creating with a git repository
+target /tmp/jl_YtpkHy/NewPkg does not exist, creating with a git repository
 applying template /home/runner/work/ITensorPkgSkeleton.jl/ITensorPkgSkeleton.jl/templates/default
 (OVER)WRITING the following files (missing or committed in the repository):
   .JuliaFormatter.toml
@@ -25,20 +25,14 @@
   benchmark/benchmarks.jl
   docs/Project.toml
   docs/make.jl
-  docs/src/index.md
+  docs/make_index.jl
   examples/Project.toml
   examples/README.jl
+  make_readme.jl
   src/NewPkg.jl
   test/Project.toml
   test/runtests.jl
   test/test_aqua.jl
   test/test_basics.jl
   test/test_examples.jl
-successfully generated NewPkg

You can generate this README with:

using Literate: Literate
-using ITensorPkgSkeleton: ITensorPkgSkeleton
-Literate.markdown(
-  joinpath(pkgdir(ITensorPkgSkeleton), "examples", "README.jl"),
-  joinpath(pkgdir(ITensorPkgSkeleton), "docs", "src");
-  flavor=Literate.DocumenterFlavor(),
-  name="index",
-)

This page was generated using Literate.jl.

+successfully generated NewPkg

This page was generated using Literate.jl.

diff --git a/dev/search_index.js b/dev/search_index.js index b87c945..1716a20 100644 --- a/dev/search_index.js +++ b/dev/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"","page":"Home","title":"Home","text":"EditURL = \"../../examples/README.jl\"","category":"page"},{"location":"#ITensorPkgSkeleton.jl","page":"Home","title":"ITensorPkgSkeleton.jl","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"(Image: Stable) (Image: Dev) (Image: Build Status) (Image: Coverage) (Image: Code Style: Blue) (Image: Aqua)","category":"page"},{"location":"#Installation-instructions","page":"Home","title":"Installation instructions","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"julia> using Pkg: Pkg\n\njulia> Pkg.add(\"https://github.com/ITensor/ITensorPkgSkeleton.jl\")","category":"page"},{"location":"#Examples","page":"Home","title":"Examples","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"using ITensorPkgSkeleton: ITensorPkgSkeleton","category":"page"},{"location":"","page":"Home","title":"Home","text":"This step might be required to circumvent issues with the version of git installed by Git.jl.","category":"page"},{"location":"","page":"Home","title":"Home","text":"ITensorPkgSkeleton.use_system_git!()","category":"page"},{"location":"","page":"Home","title":"Home","text":"If path isn't specified, it defaults to ~/.julia/dev.","category":"page"},{"location":"","page":"Home","title":"Home","text":"ITensorPkgSkeleton.generate(\"NewPkg\"; path=mktempdir())","category":"page"},{"location":"","page":"Home","title":"Home","text":"You can generate this README with:","category":"page"},{"location":"","page":"Home","title":"Home","text":"using Literate: Literate\nusing ITensorPkgSkeleton: ITensorPkgSkeleton\nLiterate.markdown(\n joinpath(pkgdir(ITensorPkgSkeleton), \"examples\", \"README.jl\"),\n joinpath(pkgdir(ITensorPkgSkeleton), \"docs\", \"src\");\n flavor=Literate.DocumenterFlavor(),\n name=\"index\",\n)","category":"page"},{"location":"","page":"Home","title":"Home","text":"","category":"page"},{"location":"","page":"Home","title":"Home","text":"This page was generated using Literate.jl.","category":"page"}] +[{"location":"","page":"Home","title":"Home","text":"EditURL = \"../../examples/README.jl\"","category":"page"},{"location":"#ITensorPkgSkeleton.jl","page":"Home","title":"ITensorPkgSkeleton.jl","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"(Image: Stable) (Image: Dev) (Image: Build Status) (Image: Coverage) (Image: Code Style: Blue) (Image: Aqua)","category":"page"},{"location":"#Installation-instructions","page":"Home","title":"Installation instructions","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"julia> using Pkg: Pkg\n\njulia> Pkg.add(\"https://github.com/ITensor/ITensorPkgSkeleton.jl\")","category":"page"},{"location":"#Examples","page":"Home","title":"Examples","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"using ITensorPkgSkeleton: ITensorPkgSkeleton","category":"page"},{"location":"","page":"Home","title":"Home","text":"This step might be required to circumvent issues with the version of git installed by Git.jl.","category":"page"},{"location":"","page":"Home","title":"Home","text":"ITensorPkgSkeleton.use_system_git!()","category":"page"},{"location":"","page":"Home","title":"Home","text":"If path isn't specified, it defaults to ~/.julia/dev.","category":"page"},{"location":"","page":"Home","title":"Home","text":"ITensorPkgSkeleton.generate(\"NewPkg\"; path=mktempdir())","category":"page"},{"location":"","page":"Home","title":"Home","text":"","category":"page"},{"location":"","page":"Home","title":"Home","text":"This page was generated using Literate.jl.","category":"page"}] }