diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000..9d05a48 Binary files /dev/null and b/.DS_Store differ diff --git a/.github/.DS_Store b/.github/.DS_Store new file mode 100644 index 0000000..36b372c Binary files /dev/null and b/.github/.DS_Store differ diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 0000000..71f39e6 --- /dev/null +++ b/.github/workflows/gh-pages.yml @@ -0,0 +1,21 @@ + name: Publish docs via GitHub + on: + push: + branches: + - main + + jobs: + build: + name: Deploy docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: 3.9 + - name: run requirements file + run: pip install -r requirements.txt + - name: Deploy docs + run: mkdocs gh-deploy --force + env: + GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..82b2bbb --- /dev/null +++ b/.gitignore @@ -0,0 +1,48 @@ +# History files +.Rhistory +.Rapp.history + +# Session Data files +.RData +.RDataTmp + +# User-specific files +.Ruserdata + +# Example code in package build process +*-Ex.R + +# Output files from R CMD build +/*.tar.gz + +# Output files from R CMD check +/*.Rcheck/ + +# RStudio files +.Rproj.user/ + +# produced vignettes +vignettes/*.html +vignettes/*.pdf + +# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3 +.httr-oauth + +# knitr and R markdown default cache directories +*_cache/ +/cache/ + +# Temporary files created by R markdown +*.utf8.md +*.knit.md + +# R Environment Variables +.Renviron + + + +# translation temp files +po/*~ + +# RStudio Connect folder +rsconnect/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8a9b45c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Environmental Data Science Innovation and Inclusion Lab (ESIIL) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..24c1864 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# Working_group_home +This is the central hub for information pertaining to ESIIL working groups diff --git a/docs/ESIIL_logo.png b/docs/ESIIL_logo.png new file mode 100644 index 0000000..0f7d2f3 Binary files /dev/null and b/docs/ESIIL_logo.png differ diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..ca12695 Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e69de29 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..c4c0344 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,71 @@ +site_name: 'ESIIL Working Group Home' +site_description: 'Central resource for ESIIL working groups' +site_author: Ty Tuff +site_url: https://cu-esiil.github.io/Working_group_home + +# Repository +repo_name: Working-group-home +repo_url: https://github.com/CU-ESIIL/Working_group_home +edit_uri: edit/main/docs/ +# Copyright +copyright: 'Copyright © 2023 University of Colorado Boulder' + +# Page tree +nav: + - Home: index.md + # TODO: Add your nav sections / sub-sections and path to markdown page Ex: + # - Remote Sensing: + # - How to Cloud Correct Sentinel-2 Images: remote_sensing/sentinel_2_cloud_correction/sentinel_2_cloud_correction.md + +# Configuration +theme: + highlightjs: true + name: material + font: + text: 'Open Sans' + code: 'Roboto Mono' + logo: 'assets/ESIIL_logo.png' + favicon: 'assets/favicon.ico' + # setting features for the navigation tab + features: + - navigation.sections + - navigation.instant + - navigation.tracking + - navigation.indexes + - navigation.top + - toc.integrate + - toc.follow + - content.code.copy + # Default values, taken from mkdocs_theme.yml + language: en + palette: + # Palette toggle for light mode + - media: "(prefers-color-scheme: white)" + primary: 'white' + toggle: + icon: material/weather-night + name: Switch to dark mode + + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/weather-sunny + name: Switch to system preference + +# Options +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/cu-esiil/ + +extra_css: + - stylesheets/extra.css + +plugins: + - search + - mkdocstrings + - git-revision-date + - mkdocs-jupyter: + include_source: True + ignore_h1_titles: True diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..c5107cb --- /dev/null +++ b/requirements.txt @@ -0,0 +1,33 @@ +bump2version +coverage +flake8 +grip +ipykernel +livereload +nbconvert==6.5 +pip +sphinx +tox +twine +watchdog +wheel +mkdocs-git-revision-date-plugin +mkdocs-jupyter +mkdocs-material +mkdocs-pdf-export-plugin +mkdocstrings +mkdocstrings-crystal +mkdocstrings-python-legacy + +# Requirements for core +jinja2>=3.0 +markdown>=3.2 +mkdocs>=1.4.2 +mkdocs-material-extensions>=1.1 +pygments>=2.14 +pymdown-extensions>=9.9.1 + +# Requirements for plugins +colorama>=0.4 +regex>=2022.4.24 +requests>=2.26 \ No newline at end of file