From b19bdd064339a9efde109a0ea03374ae1a68d8a4 Mon Sep 17 00:00:00 2001 From: cbernalz Date: Sun, 25 Aug 2024 09:37:37 -0700 Subject: [PATCH] 2024-08-25 update : simplify the docs. --- docs/make.jl | 2 -- docs/src/index.md | 4 ++-- docs/src/news.md | 14 -------------- docs/src/package_development.md | 23 ----------------------- docs/src/tutorials/getting_started.md | 2 +- 5 files changed, 3 insertions(+), 42 deletions(-) delete mode 100644 docs/src/news.md delete mode 100644 docs/src/package_development.md diff --git a/docs/make.jl b/docs/make.jl index c672f6a..d1a59b5 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -26,8 +26,6 @@ makedocs(; "UCIWWEIHR FITTING MODEL W/ FORECASTING" => "tutorials/uciwwiehr_model_fitting_forecast.md", ] , - "NEWS" => "news.md", - "PACKAGE DEVELOPMENT" => "package_development.md", "REFERENCE" => "reference.md", "LICENSE" => "license.md", ], diff --git a/docs/src/index.md b/docs/src/index.md index f5ca8b4..7c02618 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -12,7 +12,7 @@ UCIWWEIHR.jl is a Julia package for forecasting and nowcasting COVID-19 hospital - Comprehensive library of Bayesian models - Simulation of infectious disease -- Parameter estimation and model calibration +- Model calibration - Sensitivity analysis and uncertainty quantification? - Visualization of results and MCMC evaluations(live?) @@ -22,5 +22,5 @@ To install UCIWWEIHR.jl, you can use the Julia package manager. Open the Julia R ```julia using Pkg -Pkg.add("UCIWWEIHR") +Pkg.add("git@github.com:cbernalz/UCIWWEIHR.jl.git") ``` diff --git a/docs/src/news.md b/docs/src/news.md deleted file mode 100644 index f7afe53..0000000 --- a/docs/src/news.md +++ /dev/null @@ -1,14 +0,0 @@ -# [Package Development News](@id package-development-news) - -## Latest Updates - - -## Upcoming Features - - -## Bug Fixes in Progress - - -## Release Notes - - diff --git a/docs/src/package_development.md b/docs/src/package_development.md deleted file mode 100644 index 6722e8b..0000000 --- a/docs/src/package_development.md +++ /dev/null @@ -1,23 +0,0 @@ -# [Package Development Updates](@id package-development-updates) - -## [Version X.X.X] - YYYY-MM-DD - -### Added -- Feature 1: Description of the feature that was added. -- Feature 2: Description of the feature that was added. - -### Changed -- Change 1: Description of the change that was made. -- Change 2: Description of the change that was made. - -### Deprecated -- Deprecated feature 1: Description of the feature that was deprecated. -- Deprecated feature 2: Description of the feature that was deprecated. - -### Removed -- Removed feature 1: Description of the feature that was removed. -- Removed feature 2: Description of the feature that was removed. - -### Fixed -- Bug fix 1: Description of the bug that was fixed. -- Bug fix 2: Description of the bug that was fixed. \ No newline at end of file diff --git a/docs/src/tutorials/getting_started.md b/docs/src/tutorials/getting_started.md index 2767d93..1b56f9a 100644 --- a/docs/src/tutorials/getting_started.md +++ b/docs/src/tutorials/getting_started.md @@ -8,7 +8,7 @@ To install the UCIWWEIHR.jl package, open the Julia REPL and run the following c ``` julia using Pkg -Pkg.add("UCIWWEIHR") +Pkg.add("git@github.com:cbernalz/UCIWWEIHR.jl.git") ```