Skip to content

Commit 30383ad

Browse files
committed
updates for documenter v1
1 parent 5201950 commit 30383ad

File tree

4 files changed

+8
-6
lines changed

4 files changed

+8
-6
lines changed

docs/Project.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
33

44
[compat]
5-
Documenter = "0.27"
5+
Documenter = "1"
66

docs/make.jl

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
using Documenter, PowerModels
22

33
makedocs(
4+
warnonly = Documenter.except(:linkcheck),
45
modules = [PowerModels],
56
format = Documenter.HTML(analytics = "UA-367975-10", mathengine = Documenter.MathJax()),
67
sitename = "PowerModels",

docs/src/developer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -223,4 +223,4 @@ In squared voltage magnitude variables:
223223
```
224224

225225

226-
[^1] Gan, L., Li, N., Topcu, U., & Low, S. (2012). Branch flow model for radial networks: convex relaxation. 51st IEEE Conference on Decision and Control, 1–8. Retrieved from http://smart.caltech.edu/papers/ExactRelaxation.pdf
226+
[^1]: Gan, L., Li, N., Topcu, U., & Low, S. (2012). Branch flow model for radial networks: convex relaxation. 51st IEEE Conference on Decision and Control, 1–8. Retrieved from http://smart.caltech.edu/papers/ExactRelaxation.pdf

docs/src/multi-networks.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Working with Multi-Network Data
22

3-
```@setup powermodels
3+
```
44
import Pkg
55
using PowerModels
66
@@ -10,7 +10,8 @@ case3file = Pkg.dir(dirname(@__DIR__), "test", "data", "matpower", "case3.m")
1010
There are occasions when it is desirable to co-optimize multiple networks, these networks might encode time for dynamic network optimization, or scenarios for stochastic optimization.
1111

1212
To distinguish between network data (see [The Network Data Dictionary](@ref)) that correspond to a single network or to multiple networks, PowerModels.jl provides the function `ismultinetwork()`. For example, we can do the following:
13-
```@example powermodels
13+
```
14+
println(case3file)
1415
network_data = PowerModels.parse_file(case3file)
1516
pm = instantiate_model(network_data, ACPPowerModel, PowerModels.build_opf)
1617
@@ -21,13 +22,13 @@ PowerModels.jl would generally not read in network data as multi-networks. To ge
2122
PowerModels.replicate
2223
```
2324
For example, we can make three replicates by calling
24-
```@example powermodels
25+
```
2526
network_data3 = PowerModels.replicate(network_data, 3)
2627
```
2728
Observe that the structure of `network_data3` is different from that of `network_data`, since it is a multi-network. The user can then modify each replicate of the network to vary in the corresponding parameter of interest. See [`test/common.jl`](https://github.com/lanl-ansi/PowerModels.jl/blob/master/test/common.jl) for examples on setting up valid Multi-Network data.
2829

2930
To build a PowerModel from a multinetwork data dictionary (see [Building PowerModels from Network Data Dictionaries](@ref)), we supply `multinetwork=true` during the call to `build_generic_model` and replace `build_opf` with `build_mn_opf`,
30-
```@example powermodels
31+
```
3132
pm3 = PowerModels.instantiate_model(network_data3, ACPPowerModel, PowerModels.build_mn_opf, multinetwork=true)
3233
3334
PowerModels.ismultinetwork(pm3)

0 commit comments

Comments
 (0)