Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ttuff authored Dec 18, 2023
0 parents commit c54494d
Show file tree
Hide file tree
Showing 11 changed files with 196 additions and 0 deletions.
Binary file added .DS_Store
Binary file not shown.
Binary file added .github/.DS_Store
Binary file not shown.
21 changes: 21 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -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 }}
48 changes: 48 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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/
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Working_group_home
This is the central hub for information pertaining to ESIIL working groups
Binary file added docs/ESIIL_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/favicon.ico
Binary file not shown.
Empty file added docs/index.md
Empty file.
71 changes: 71 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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
33 changes: 33 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit c54494d

Please sign in to comment.