Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jd/fix docs #26

Merged
merged 13 commits into from
Feb 6, 2024
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ PowerSystems = "bcd98974-b02a-5e2f-9ee0-a103f5c450dd"
TimeSeries = "9e3dc215-6440-5c97-bce1-76c03772f85e"

[compat]
Documenter = "0.27"
Documenter = "1"
InfrastructureSystems = "1"
julia = "^1.6"
8 changes: 5 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,27 @@ using DataStructures
pages = OrderedDict(
"Welcome Page" => "index.md",
"Quick Start Guide" => "quick_start_guide.md",
"Formulation Library" =>
Any["StorageDispatchWithReserves" => "formulation_library/StorageDispatchWithReserves.md",],
"Code Base Developer Guide" =>
Any["Developer Guide" => "code_base_developer_guide/developer.md",],
"Formulation Library" => Any["Storage" => "formulation_library/Storage.md",],
"API Reference" => "api/StorageSystemsSimulations.md",
)

makedocs(;
modules=[StorageSystemsSimulations],
format=Documenter.HTML(; prettyurls=haskey(ENV, "GITHUB_ACTIONS")),
warnonly=[:missing_docs],
sitename="StorageSystemsSimulations.jl",
authors="Sourabh Dalvi, Jose Daniel Lara",
authors="Jose Daniel Lara, Rodrigo Henriquez-Auba, Sourabh Dalvi",
pages=Any[p for p in pages],
)

deploydocs(;
repo="github.com/NREL-Sienna/StorageSystemsSimulations.jl.git",
target="build",
branch="gh-pages",
devbranch="master",
devbranch="main",
devurl="dev",
push_preview=true,
versions=["stable" => "v^", "v#.#"],
Expand Down
4 changes: 2 additions & 2 deletions docs/src/code_base_developer_guide/developer.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Guidelines for Developers

In order to contribute to `PowerSystems.jl` repository please read the following sections of
In order to contribute to `StorageSystemsSimulations.jl` repository please read the following sections of
[`InfrastructureSystems.jl`](https://github.com/NREL-Sienna/InfrastructureSystems.jl)
documentation in detail:

1. [Style Guide](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/style/)
2. [Contributing Guidelines](https://github.com/NREL-Sienna/PowerSystems.jl/blob/master/CONTRIBUTING.md)
2. [Contributing Guidelines](https://github.com/NREL-Sienna/StorageSystemsSimulations.jl/blob/master/CONTRIBUTING.md)

Pull requests are always welcome to fix bugs or add additional modeling capabilities.

Expand Down
15 changes: 0 additions & 15 deletions docs/src/formulation_library/README.md

This file was deleted.

244 changes: 0 additions & 244 deletions docs/src/formulation_library/Storage.md

This file was deleted.

Loading
Loading