Skip to content

Commit 8adca63

Browse files
authored
Move some docstrings to internals page (#89)
1 parent 9075207 commit 8adca63

File tree

3 files changed

+18
-2
lines changed

3 files changed

+18
-2
lines changed

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ makedocs(
1313
pages = Any[
1414
"Home" => "index.md",
1515
"Showcase" => "showcase.md",
16+
"Internals" => "internals.md",
1617
],
1718
format = Documenter.HTML(
1819
assets = ["assets/favicon.ico"],

docs/src/index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,16 @@ DocStringExtensions
77
## Index
88

99
```@index
10-
Modules = [DocStringExtensions]
10+
Pages = ["index.md"]
1111
```
1212

1313
## Reference
1414

1515
```@autodocs
1616
Modules = [DocStringExtensions]
17-
Order = [:constant, :function, :macro, :type]
17+
Order = [:constant]
1818
```
1919

20+
```@docs
21+
DocStringExtensions.@template
22+
```

docs/src/internals.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Internals
2+
3+
These functions, types etc. are internal to DocStringExtensions and **not part of the public API**. They may change or be removed arbitrarily from version to version.
4+
5+
```@index
6+
Pages = ["internals.md"]
7+
```
8+
9+
```@autodocs
10+
Modules = [DocStringExtensions]
11+
Order = [:function, :type]
12+
```

0 commit comments

Comments
 (0)