Skip to content

Commit 0ae2f33

Browse files
committed
Add full type tree and move variable cost options to reference
1 parent 8f63f20 commit 0ae2f33

File tree

4 files changed

+13
-7
lines changed

4 files changed

+13
-7
lines changed

docs/make.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,14 @@ pages = OrderedDict(
3838
"explanation/per_unit.md",
3939
"explanation/time_series.md",
4040
"explanation/example_dynamic_data.md",
41-
"explanation/cost_functions.md",
4241
],
4342
"Model Library" => Any[],
4443
"Reference" =>
4544
Any["Public API" => "api/public.md",
4645
"Internal API Reference" => "api/internal.md",
4746
"Glossary and Acronyms" => "api/glossary.md",
47+
"Type Hierarchy" => "api/type_tree.md",
48+
"Variable Cost Options" => "api/variable_costs.md",
4849
"Specifying the category of..." => "api/enumerated_types.md",
4950
"Developer Guidelines" => "api/developer_guidelines.md",
5051
"Citation" => "api/citation.md"

docs/src/api/type_tree.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Type Hierarchy
2+
3+
Here is the complete `PowerSystems.jl` type hierarchy:
4+
5+
```@repl types
6+
using PowerSystems #hide
7+
import TypeTree: tt #hide
8+
docs_dir = joinpath(pkgdir(PowerSystems), "docs", "src", "tutorials", "utils"); #hide
9+
include(joinpath(docs_dir, "docs_utils.jl")); #hide
10+
print(join(tt(PowerSystems.IS.InfrastructureSystemsType), "")) #hide
11+
```

docs/src/explanation/type_structure.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,3 @@ implemented in the package.
5757
```@raw html
5858
<img src="../assets/AbstractTree.png" width="75%"/>
5959
``` ⠀
60-
61-
The following code displays the hierarchy, but concrete types are omitted for brevity:
62-
63-
```@repl types
64-
print(join(tt(PowerSystems.IS.InfrastructureSystemsType, concrete = false), ""))
65-
```

0 commit comments

Comments
 (0)