Add Reference page to documentation (#43)

This adds a page to the documentation to automatically generate all docstrings.
ITensor · Jan 15, 2025 · 9cfd842 · 9cfd842
1 parent 07dd797
commit 9cfd842
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/docs/src/reference.md b/docs/src/reference.md
@@ -1,7 +1,5 @@
-## Reference
+# Reference
 
-```@docs
-ITensorPkgSkeleton.generate
-ITensorPkgSkeleton.default_templates
-ITensorPkgSkeleton.all_templates
+```@autodocs
+Modules = [ITensorPkgSkeleton]
 ```
diff --git a/templates/docs/docs/make.jl b/templates/docs/docs/make.jl
@@ -16,7 +16,7 @@ makedocs(;
     edit_link="main",
     assets=String[],
   ),
-  pages=["Home" => "index.md"],
+  pages=["Home" => "index.md", "Reference" => "reference.md"],
 )
 
 deploydocs(;

diff --git a/templates/docs/docs/src/reference.md b/templates/docs/docs/src/reference.md
@@ -0,0 +1,5 @@
+# Reference
+
+```@autodocs
+Modules = [{PKGNAME}]
+```