add to doc

sunxd3 · sunxd3 · commit 44de81ce138d · 2024-08-23T13:53:10.000+01:00
diff --git a/docs/make.jl b/docs/make.jl
@@ -8,7 +8,7 @@ makedocs(;
     sitename="AbstractMCMC",
     format=Documenter.HTML(),
     modules=[AbstractMCMC],
-    pages=["Home" => "index.md", "api.md", "design.md"],
+    pages=["Home" => "index.md", "api.md", "design.md", "gibbs.md"],
     checkdocs=:exports,
 )
 
diff --git a/docs/src/gibbs.md b/docs/src/gibbs.md
@@ -1,4 +1,4 @@
-# `state` Interface
+# `state` Interface Functions
 
 We encourage sampler packages to implement the following interface functions for the `state` type(s) they maintain:
 
diff --git a/test/runtests.jl b/test/runtests.jl
@@ -24,4 +24,5 @@ include("utils.jl")
     include("stepper.jl")
     include("transducer.jl")
     include("logdensityproblems.jl")
+    include("gibbs_example/gibbs.jl")
 end

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ makedocs(;`
`8`	`8`	`sitename="AbstractMCMC",`
`9`	`9`	`format=Documenter.HTML(),`
`10`	`10`	`modules=[AbstractMCMC],`
`11`		`- pages=["Home" => "index.md", "api.md", "design.md"],`
	`11`	`+ pages=["Home" => "index.md", "api.md", "design.md", "gibbs.md"],`
`12`	`12`	`checkdocs=:exports,`
`13`	`13`	`)`
`14`	`14`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-# `state` Interface
	`1`	+# `state` Interface Functions
`2`	`2`
`3`	`3`	We encourage sampler packages to implement the following interface functions for the `state` type(s) they maintain:
`4`	`4`