Merge branch 'NCAR:main' into template

NCAR · Nov 16, 2023 · cfc3426 · cfc3426
2 parents a275386 + 66a8c93
commit cfc3426
Show file tree

Hide file tree

Showing 31 changed files with 646 additions and 95 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -21,7 +21,7 @@ concurrency:
   group: "pages"
   cancel-in-progress: false
 
-jobs:      
+jobs:
   deploy:
     environment:
       name: github-pages
@@ -30,12 +30,13 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v3
-      - name: install dependencies
+      - name: Install dependencies
         run: |
-          pip install jupyter-book
-      - name: jupyter-book build .
+          python -m pip install --upgrade pip
+          pip install sphinx-book-theme myst-nb sphinx-design nbsphinx
+      - name: make html
         run: |
-          jupyter-book build .
+          make html
       - name: Setup Pages
         uses: actions/configure-pages@v3
       - name: what do we have in here

diff --git a/.gitignore b/.gitignore
@@ -158,4 +158,7 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/
+
+# Mac
+.DS_Store
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,6 +4,6 @@
 
 `conda activate geocat-applications`
 
-`jupyter-book build .`
+`make clean html`
 
 `open _build/html/index.html`
diff --git a/Makefile b/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/README.md b/README.md
@@ -1,3 +1,3 @@
 # geocat-applications
 
-This is the source repository for [GeoCAT-applications]().
+This is the source repository for GeoCAT-applications.
diff --git a/_config.yml b/_config.yml
diff --git a/_static/images/logos/GeoCAT_long.svg b/_static/images/logos/GeoCAT_long.svg
diff --git a/_static/images/logos/GeoCAT_nsf.svg b/_static/images/logos/GeoCAT_nsf.svg
diff --git a/_static/images/logos/GeoCAT_square.svg b/_static/images/logos/GeoCAT_square.svg
diff --git a/_static/logos/NCAR-contemp-logo-blue.svg → ...c/images/logos/NCAR-contemp-logo-blue.svg b/_static/logos/NCAR-contemp-logo-blue.svg → ...c/images/logos/NCAR-contemp-logo-blue.svg
diff --git a/_static/logos/footer-logo-nsf.png → _static/images/logos/footer-logo-nsf.png b/_static/logos/footer-logo-nsf.png → _static/images/logos/footer-logo-nsf.png
diff --git a/_static/images/logos/nsf.png b/_static/images/logos/nsf.png
diff --git a/_static/logos/geocat.png b/_static/logos/geocat.png
diff --git a/_static/style.css b/_static/style.css
@@ -0,0 +1,27 @@
+/* override the default image top css */
+.sd-card-img-top {
+    width: 15% !important;
+    position: absolute !important;
+    padding-left: 10px;
+    min-width: 50px;
+    top: 50%;
+    transform: translateY(-50%);
+
+}
+
+/* override the default background image behavior */
+.sd-card-img {
+    height: auto;
+}
+
+/* override toc css */
+/* controls dropdown icon color */
+.bd-toc-item.active {
+    margin-bottom: 1rem;
+    color: #012169;
+}
+
+/* controls sidebar header color */
+.caption-text {
+    color: #012169;
+}
diff --git a/_static/theme_overrides.css b/_static/theme_overrides.css
@@ -0,0 +1,15 @@
+/* delete margin from side of content */
+.wy-nav-content {
+    max-width: none !important;
+}
+
+.custom-title {
+    font-weight: bold;
+    color: #012169;
+    text-align: left;
+}
+
+.custom-body {
+    text-align: left;
+    margin-left: max(45px, 15%);
+}
diff --git a/_toc.yml b/_toc.yml
diff --git a/applications/data_analysis/data_analysis.rst b/applications/data_analysis/data_analysis.rst
@@ -0,0 +1,12 @@
+.. currentmodule:: geocat.applications
+
+.. _applications_data_analysis:
+
+Data Analysis
+=============
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   sample.ipynb
diff --git a/data_analysis/sample.ipynb → applications/data_analysis/sample.ipynb b/data_analysis/sample.ipynb → applications/data_analysis/sample.ipynb
diff --git a/applications/file_io/file_io.rst b/applications/file_io/file_io.rst
@@ -0,0 +1,12 @@
+.. currentmodule:: geocat.applications
+
+.. _applications_file_io:
+
+File I/O
+========
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   sample.ipynb
diff --git a/file_io/sample.ipynb → applications/file_io/sample.ipynb b/file_io/sample.ipynb → applications/file_io/sample.ipynb
diff --git a/plot_types/contour.ipynb → applications/plot_types/contour.ipynb b/plot_types/contour.ipynb → applications/plot_types/contour.ipynb
diff --git a/applications/plot_types/plot_types.rst b/applications/plot_types/plot_types.rst
@@ -0,0 +1,12 @@
+.. currentmodule:: geocat.applications
+
+.. _applications_plot_types:
+
+Plot Types
+==========
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   contour.ipynb