Switch to Documenter.jl

This commit is contained in:
2022-07-17 14:44:58 -06:00
parent b68b4ff9e4
commit 18daaf5358
16 changed files with 146 additions and 224 deletions

48
docs/src/api.md Normal file
View File

@@ -0,0 +1,48 @@
# API Reference
## Read data, build model & optimize
```@docs
UnitCommitment.read
UnitCommitment.read_benchmark
UnitCommitment.build_model
UnitCommitment.optimize!
UnitCommitment.solution
UnitCommitment.validate
UnitCommitment.write
```
## Modify instance
```@docs
UnitCommitment.slice
UnitCommitment.randomize!
generate_initial_conditions!
```
## Formulations
```@docs
UnitCommitment.ArrCon2000
UnitCommitment.CarArr2006
UnitCommitment.DamKucRajAta2016
UnitCommitment.Gar1962
UnitCommitment.KnuOstWat2018
UnitCommitment.MorLatRam2013
UnitCommitment.PanGua2016
UnitCommitment.WanHob2016
```
## Solution Methods
```@docs
UnitCommitment.XavQiuWanThi2019
UnitCommitment.XavQiuWanThi2019.Method
```
## Randomization Methods
```@docs
UnitCommitment.XavQiuAhm2021
UnitCommitment.XavQiuAhm2021.Randomization
```