Skip to content

Commit

Permalink
Update to Documenter 1.0 enforcing everything except doc size and mis…
Browse files Browse the repository at this point in the history
…sing docstrings
  • Loading branch information
kdayday committed Aug 20, 2024
1 parent 7251b43 commit 2fadabf
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ TypeTree = "04da0e3b-1cad-4b2c-a963-fc1602baf1af"

[compat]
CSV = "~0.10"
Documenter = "^0.27"
Documenter = "^1.5"
InfrastructureSystems = "2"
julia = "^1.6"
20 changes: 18 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -130,10 +130,26 @@ end

makedocs(
modules = [PowerSystems, InfrastructureSystems],
format = Documenter.HTML(prettyurls = haskey(ENV, "GITHUB_ACTIONS"),),
format = Documenter.HTML(
prettyurls = haskey(ENV, "GITHUB_ACTIONS"),
size_threshold = nothing,),
sitename = "PowerSystems.jl",
authors = "Jose Daniel Lara, Daniel Thom, Kate Doubleday, and Clayton Barrows",
pages = Any[p for p in pages]
pages = Any[p for p in pages],
warnonly = Documenter.except(
:autodocs_block,
:cross_references,
:docs_block,
:doctest,
:eval_block,
:example_block,
:footnote,
:linkcheck_remotes,
:linkcheck,
:meta_block,
:parse_error,
:setup_block),
draft = false,
)

deploydocs(
Expand Down
1 change: 0 additions & 1 deletion docs/src/tutorials/creating_system.md
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,6 @@ and modified the `System` per-unit settings.

Next, you might want to:
- [Add time series data to components in the `System`](@ref tutorial_time_series)
- [Learn more about how to retrieve components and their data from a `System`](@ref get_components_tutorial)
- [Import a `System` from an existing Matpower or PSSE file instead of creating it manually](@ref parsing)
- [Create your own `System` from .csv files instead of creating it manually](@ref table_data)
- [Read more to understand per-unitization in PowerSystems.jl](@ref per_unit)
Expand Down

0 comments on commit 2fadabf

Please sign in to comment.