Skip to content

Commit 9cfd842

Browse files
authored
Add Reference page to documentation (#43)
This adds a page to the documentation to automatically generate all docstrings.
1 parent 07dd797 commit 9cfd842

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

docs/src/reference.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
## Reference
1+
# Reference
22

3-
```@docs
4-
ITensorPkgSkeleton.generate
5-
ITensorPkgSkeleton.default_templates
6-
ITensorPkgSkeleton.all_templates
3+
```@autodocs
4+
Modules = [ITensorPkgSkeleton]
75
```

templates/docs/docs/make.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ makedocs(;
1616
edit_link="main",
1717
assets=String[],
1818
),
19-
pages=["Home" => "index.md"],
19+
pages=["Home" => "index.md", "Reference" => "reference.md"],
2020
)
2121

2222
deploydocs(;
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Reference
2+
3+
```@autodocs
4+
Modules = [{PKGNAME}]
5+
```

0 commit comments

Comments
 (0)