Skip to content

Commit 21e6168

Browse files
Sébastien LoiselSébastien Loisel
authored andcommitted
Docs: split the docstring reference into an API Reference tab
Move the Module/Types/Functions autodocs blocks and the documented-names index off the Home page into docs/src/reference.md, with its own sidebar tab after PyAMG. Home ends with a pointer to the reference page and the extension pages. index.html shrinks from ~210KB to ~129KB.
1 parent 08569fd commit 21e6168

3 files changed

Lines changed: 48 additions & 29 deletions

File tree

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ makedocs(;
2929
"JuMP" => "jump.md",
3030
"Gmsh" => "gmsh.md",
3131
"PyAMG" => "pyamg.md",
32+
"API Reference" => "reference.md",
3233
],
3334
)
3435

docs/src/index.md

Lines changed: 5 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -373,33 +373,9 @@ the coordinate-dedup default cannot produce.
373373
levels using purely geometric subdivision transfers (no AMG coarsening). Kept for
374374
cases that need geometric transfers specifically.
375375

376-
# Module reference
376+
# Reference
377377

378-
```@autodocs
379-
Modules = [MultiGridBarrier]
380-
Order = [:module]
381-
Private = false
382-
```
383-
384-
# Types reference
385-
386-
```@autodocs
387-
Modules = [MultiGridBarrier]
388-
Order = [:type]
389-
Private = false
390-
Filter = t -> !(nameof(t) in (:MGBModel, :Coef, :EpiPower, :deriv, :integral, :set_start, :mgb_solution, :solver_log, :On, :Broken, :Continuous, :Uniform, :gmsh_import, :amg_pyamg, :MGB3DFigure, :HTML5anim))
391-
```
392-
393-
# Functions reference
394-
395-
```@autodocs
396-
Modules = [MultiGridBarrier]
397-
Order = [:function]
398-
Private = false
399-
Filter = t -> !(nameof(t) in (:MGBModel, :Coef, :EpiPower, :deriv, :integral, :set_start, :mgb_solution, :solver_log, :On, :Broken, :Continuous, :Uniform, :gmsh_import, :amg_pyamg, :MGB3DFigure, :HTML5anim))
400-
```
401-
402-
# Index
403-
404-
```@index
405-
```
378+
The full docstring reference (module, types, functions, and the index of all
379+
documented names) lives on the [API reference](reference.md) page; the
380+
extension APIs are documented on the [Plotting](plotting.md),
381+
[JuMP](jump.md), [Gmsh](gmsh.md), and [PyAMG](pyamg.md) pages.

docs/src/reference.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
```@meta
2+
CurrentModule = MultiGridBarrier
3+
```
4+
5+
# API reference
6+
7+
The docstrings of the core module. The extension APIs are documented on their
8+
own pages — [Plotting](plotting.md) (`plot`, `MGB3DFigure`, `HTML5anim`),
9+
[JuMP](jump.md) (`MGBModel` and the modeling macros' helpers),
10+
[Gmsh](gmsh.md) (`gmsh_import`), and [PyAMG](pyamg.md) (`amg_pyamg`) — and the
11+
[index](@ref main-index) below links to everything.
12+
13+
## Module
14+
15+
```@autodocs
16+
Modules = [MultiGridBarrier]
17+
Order = [:module]
18+
Private = false
19+
```
20+
21+
## Types
22+
23+
```@autodocs
24+
Modules = [MultiGridBarrier]
25+
Order = [:type]
26+
Private = false
27+
Filter = t -> !(nameof(t) in (:MGBModel, :Coef, :EpiPower, :deriv, :integral, :set_start, :mgb_solution, :solver_log, :On, :Broken, :Continuous, :Uniform, :gmsh_import, :amg_pyamg, :MGB3DFigure, :HTML5anim))
28+
```
29+
30+
## Functions
31+
32+
```@autodocs
33+
Modules = [MultiGridBarrier]
34+
Order = [:function]
35+
Private = false
36+
Filter = t -> !(nameof(t) in (:MGBModel, :Coef, :EpiPower, :deriv, :integral, :set_start, :mgb_solution, :solver_log, :On, :Broken, :Continuous, :Uniform, :gmsh_import, :amg_pyamg, :MGB3DFigure, :HTML5anim))
37+
```
38+
39+
## [Index](@id main-index)
40+
41+
```@index
42+
```

0 commit comments

Comments
 (0)