Browse Source

DOC: Build API docs for Graphs module.

pull/329/head
Evan Patterson 2 months ago
parent
commit
e551de62a5
2 changed files with 14 additions and 2 deletions
  1. +3
    -2
      docs/make.jl
  2. +11
    -0
      docs/src/apis/graphs.md

+ 3
- 2
docs/make.jl View File

@ -7,8 +7,8 @@ const generated_dir = joinpath(@__DIR__, "src", "generated")
@info "Loading Catlab.jl"
using Catlab,
# Must explicitly load all submodules for which docs are needed.
Catlab.Theories, Catlab.CategoricalAlgebra, Catlab.WiringDiagrams,
Catlab.Graphics, Catlab.Programs, Catlab.LinearAlgebra
Catlab.Theories, Catlab.CategoricalAlgebra, Catlab.Graphs,
Catlab.WiringDiagrams, Catlab.Graphics, Catlab.Programs, Catlab.LinearAlgebra
@info "Building Literate.jl docs"
@ -64,6 +64,7 @@ makedocs(
"apis/core.md",
"apis/theories.md",
"apis/categorical_algebra.md",
"apis/graphs.md",
"apis/wiring_diagrams.md",
"apis/graphics.md",
"apis/programs.md",


+ 11
- 0
docs/src/apis/graphs.md View File

@ -0,0 +1,11 @@
# [Graphs](@id graphs)
```@autodocs
Modules = [
Graphs.BasicGraphs,
Graphs.EmbeddedGraphs,
Graphs.PropertyGraphs,
Graphs.GraphAlgorithms,
]
Private = false
```

Loading…
Cancel
Save