Merge pull request #267 from tkf/private-docstrings

vchuravy · web-flow · commit a5fa0f3e0ff1 · 2021-12-01T16:10:53.000-05:00
Exclude internals from reference
diff --git a/docs/make.jl b/docs/make.jl
@@ -17,6 +17,7 @@ makedocs(;
         "Manual" => "manual.md",
         "Linux-based environments" => "linuxtips.md",
         "Reference" => "reference.md",
+        hide("Internals" => "internals.md"),
     ],
 )
 
diff --git a/docs/src/internals.md b/docs/src/internals.md
@@ -0,0 +1,7 @@
+# Internals
+
+```@autodocs
+Modules = [BenchmarkTools]
+Public = false
+Filter = f -> f !== Base.run
+```
diff --git a/docs/src/reference.md b/docs/src/reference.md
@@ -2,4 +2,9 @@
 
 ```@autodocs
 Modules = [BenchmarkTools]
+Private = false
+```
+
+```@docs
+Base.run
 ```

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ makedocs(;`
`17`	`17`	`"Manual" => "manual.md",`
`18`	`18`	`"Linux-based environments" => "linuxtips.md",`
`19`	`19`	`"Reference" => "reference.md",`
	`20`	`+ hide("Internals" => "internals.md"),`
`20`	`21`	`],`
`21`	`22`	`)`
`22`	`23`