Merge pull request #384 from NREL-Sienna/jd/restore_docs

Update make.jl

.github/workflows/docs.yml

@@ -13,9 +13,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: julia-actions/setup-julia@v1
+      - uses: julia-actions/setup-julia@v2
         with:
-          version: '1.6'
+          version: '1'
       - name: Install dependencies
         run: julia --project=docs -e 'using Pkg; Pkg.update(); Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
       - name: Build and deploy

README.md

@@ -5,13 +5,13 @@
 [![Documentation](https://github.com/NREL-Sienna/InfrastructureSystems.jl/workflows/Documentation/badge.svg)](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/)
 [![DOI](https://zenodo.org/badge/202787784.svg)](https://zenodo.org/badge/latestdoi/202787784)
 
-The `InfrastructureSystems.jl` package provides utilities to support data models for infrastructure modeling in [NREL-Sienna](https://github.com/NREL-Sienna). The `InfrastructureSystems.jl` package is used to support functionalities in [PowerSystems.jl](https://github.com/NREL-Sienna/PowerSystems.jl), [PowerSimulations.jl](https://github.com/NREL-Sienna/PowerSimulations.jl), [PowerSimulationsDynamics.jl](https://github.com/NREL-Sienna/PowerSimulationsDynamics.jl) and other modeling packages in the Sienna ecosystem. 
+The `InfrastructureSystems.jl` package provides utilities to support data models for infrastructure modeling in [NREL-Sienna](https://github.com/NREL-Sienna). The `InfrastructureSystems.jl` package is used to support functionalities in [PowerSystems.jl](https://github.com/NREL-Sienna/PowerSystems.jl), [PowerSimulations.jl](https://github.com/NREL-Sienna/PowerSimulations.jl), [PowerSimulationsDynamics.jl](https://github.com/NREL-Sienna/PowerSimulationsDynamics.jl) and other modeling packages in the Sienna ecosystem.
 
 This package is only compatible with Julia 1.6 or higher.
 
 ## Development
 
-Contributions to the development and enahancement of PowerSystems is welcome. Please see [CONTRIBUTING.md](https://github.com/NREL-Sienna/InfrastructureSystems.jl/blob/master/CONTRIBUTING.md) for code contribution guidelines.
+Contributions to the development and enahancement of InfrastructureSystems is welcome. Please see [CONTRIBUTING.md](https://github.com/NREL-Sienna/InfrastructureSystems.jl/blob/master/CONTRIBUTING.md) for code contribution guidelines.
 
 ## License
 

docs/Project.toml

@@ -6,7 +6,4 @@ InfrastructureSystems = "2cd47ed4-ca9b-11e9-27f2-ab636a7671f1"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 
 [compat]
-CSV = "~0.9"
-Documenter = "0.25"
 InfrastructureSystems = "2"
-julia = "^1.5"

docs/make.jl

@@ -46,16 +46,20 @@ end
 
 makedocs(
     modules = [InfrastructureSystems],
-    format = Documenter.HTML(prettyurls = haskey(ENV, "GITHUB_ACTIONS"),),
+    format = Documenter.HTML(
+        prettyurls = haskey(ENV, "GITHUB_ACTIONS"),
+        size_threshold = nothing),
     sitename = "InfrastructureSystems.jl",
-    pages = Any[p for p in pages]
+    pages = Any[p for p in pages],
+    warnonly = Documenter.except(),
 )
 
+
 deploydocs(
     repo = "github.com/NREL-Sienna/InfrastructureSystems.jl.git",
     target = "build",
     branch = "gh-pages",
-    devbranch = "master",
+    devbranch = "main",
     devurl = "dev",
     versions = ["stable" => "v^", "v#.#"],
     push_preview = true,

docs/src/dev_guide/tests.md

@@ -1,54 +1,61 @@
 # Running Tests
 
 ## Standard test execution
+
 Unit tests can be executed in the REPL by executing the following:
 
 ```julia
 julia> ] test
 ```
 
 ## Interactive test execution
+
 While developing code and tests it can be convenient to run a subset of tests.
 You can do this with a combination of TestEnv.jl and ReTest.jl.
 
 **Note**: Per recommendations from the developers of TestEnv.jl, install the package
 in your global julia environment. Do the same for Revise.jl.
 
-```
+```console
 $ julia
 julia> ]
 (@v1.10) pkg> add TestEnv Revise
 ```
 
 Start the environment with the InfrastructureSystems.jl environment.
-```
+
+```console
 $ julia --project
 ```
 
 Load the test environment.
+
 ```
 julia> using TestEnv
 julia> TestEnv.activate()
 ```
 
 Load the tests through ReTest.jl and Revise.jl.
+
 ```julia
 julia> include("test/load_tests.jl")
 ```
 
 Run all tests.
+
 ```julia
 julia> run_tests()
 ```
 
 Run a subset of tests with a regular expression. This pattern matches multiple testset definitions.
 The `run_tests` function forwards all arguments and keyword arguments to `ReTest.retest`.
+
 ```
 julia> run_tests(r"Test.*components")
 ```
 
 Refer to the [ReTest documentation](https://juliatesting.github.io/ReTest.jl/stable/) for more
-information. 
+information.
 
 ## Change logging levels
 
@@ -58,13 +65,15 @@ julia> ENV["SIENNA_LOGGING_CONFIG"] = "logging_config.toml"
 ```
 
 Edit the file to suit your preferences and rerun.
+
 ```julia
 julia> run_tests()
 ```
 
 **Note** that you can filter out noisy log groups in this file.
 
 ## Noisy log messages
+
 The unit test module appends a summary of all log message counts to the log
 file.  If a message is logged too frequently then consider tagging that message
 with maxlog=X to suppress it.

docs/src/dev_guide/time_series.md

@@ -94,7 +94,7 @@ size of the HDF5 does not decrease. The only way to recover this space is to
 build a new file with only the active objects. The HDF5 tools package provides
 the tool `h5repack` for this purpose.
 
-```bash
+```console
 $ h5repack time_series.h5 new.h5
 $ mv new.h5 time_series.h5
 ```

docs/src/index.md

@@ -4,7 +4,7 @@
 CurrentModule = InfrastructureSystems
 ```
 
-### Overview
+## Overview
 
 `InfrastructureSystems.jl` is a [`Julia`](http://www.julialang.org) package that provides
 data management services and common utility software for the packages in

docs/src/style.md

@@ -136,7 +136,7 @@ add their own as needed.
 
 ## Unit Tests
 
-All code should be tested. The packages in SIIP have a minimum of 70% coverage to be merged
+All code should be tested. The packages in Sienna have a minimum of 70% coverage to be merged
 into master. This functionality is provided using Codecov
 
 ## Whitespace