From 42aa0da364fcf401d00adb0b76fa79d7cd9afbed Mon Sep 17 00:00:00 2001 From: Soolu Thomas Date: Sun, 11 Feb 2024 17:45:46 -0500 Subject: [PATCH 1/2] Rename index.md to README.md --- docs/{index.md => README.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{index.md => README.md} (100%) diff --git a/docs/index.md b/docs/README.md similarity index 100% rename from docs/index.md rename to docs/README.md From 73cd2547a82e6cabc04a04c556f56cdc7158d3d4 Mon Sep 17 00:00:00 2001 From: Julieanna Bacon Date: Thu, 15 Feb 2024 12:00:31 -0500 Subject: [PATCH 2/2] docs: Updated README link to hosted documentation for setup instructions, moved instructions for building the docs locally to setup.md, modified the mac OS pixi installation instructions based on test run with Matt. --- README.md | 2 +- docs/README.md | 44 -------------------------------------------- docs/index.md | 6 ++++++ docs/setup.md | 45 ++++++++++++++++++++++++++++++++++++++++++++- 4 files changed, 51 insertions(+), 46 deletions(-) delete mode 100644 docs/README.md create mode 100644 docs/index.md diff --git a/README.md b/README.md index e77934f..08222e3 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ ## Welcome and Installation Guide Welcome to the project! This is a Data Science Master's Capstone at Harvard University's Extension School, in collaboration with NOAA. -Please see here for project setup and installation: [Setup](docs/setup.md). +Please see here for project setup and installation: [Setup](https://noaa-hes-capstone.github.io/icedyno/setup/).

NOAA Logo diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index e15b0f9..0000000 --- a/docs/README.md +++ /dev/null @@ -1,44 +0,0 @@ -# IceDyno Documentation -## Short-Term Forecasting of Sea-Ice Edge Boundaries in the Arctic -**Authors:** Ruchi Asthana, Julieanna Bacon, Brendon Gory, Matthew Thanos, Soolu Thomas - -Welcome to the project! -This is a data science Master's capstone through Harvard University's Extension School, in collaboration with NOAA. - -## Documentation -Mkdocs is the documentation engine that takes hand-written markdown files to a project website. -Please read more at https://www.mkdocs.org/. - -Mkdocstrings is a mkdocs extension that allows autogenerated documentation to be made, by scraping type hints and documentation strings for any python modules within the project. - -### Building and serving the documentation commands - -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. - -### Documentation files layout - - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. - -#### Add a new page or subpage -To add a new page, in `mkdocs.yml` add the page (or subpage) by: -``` -site_name: IceDyno Documentation - -nav: - - Home: index.md - - Setup: setup.md - - New Page: newpage.md - - New SubPage: newsubpage.md - - ... -``` - -#### Autogenerate documentation for an IceDyno module - -Add to a markdown file something like this: -`::: icedyno.preprocess` diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..051de54 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,6 @@ +# IceDyno Documentation +## Short-Term Forecasting of Sea-Ice Edge Boundaries in the Arctic +**Authors:** Ruchi Asthana, Julieanna Bacon, Brendon Gory, Matthew Thanos, Soolu Thomas + +Welcome to the project! +This is a data science Master's capstone through Harvard University's Extension School, in collaboration with NOAA. diff --git a/docs/setup.md b/docs/setup.md index 36bc017..dad8f5e 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,7 +1,10 @@ # Setup -To get started, clone the repo, checkout this branch, using Linux or Mac install pixi with: +To get started, clone the repo, checkout this branch, using Linux install pixi with: ```curl -fsSL https://pixi.sh/install.sh | bash``` +For Mac, install via homebrew with +```homebrew install pixi``` + If using windows, install pixi with: ```iwr -useb https://pixi.sh/install.ps1 | iex``` @@ -48,3 +51,43 @@ You'll see that the `pixi.toml` and `pixi.lock` files will change after adding y ## Removing a dependency ```pixi remove package_name``` + + +# Documentation +Mkdocs is the documentation engine that takes hand-written markdown files to a project website. +Please read more at https://www.mkdocs.org/. + +Mkdocstrings is a mkdocs extension that allows autogenerated documentation to be made, by scraping type hints and documentation strings for any python modules within the project. + +## Building and serving the documentation commands locally + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Documentation files layout + + mkdocs.yml # The configuration file. + docs/ + images/ # Folder for storing local images for documentation, including for the README.md. + index.md # The documentation homepage. + ... # Other markdown pages. + +### Add a new page or subpage +To add a new page, in `mkdocs.yml` add the page (or subpage) by: +``` +site_name: IceDyno Documentation + +nav: + - Home: index.md + - Setup: setup.md + - New Page: newpage.md + - New SubPage: newsubpage.md + - ... +``` + +### Autogenerate documentation for an IceDyno module + +Add to a markdown file something like this: +`::: icedyno.preprocess` \ No newline at end of file