MkDocs #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

unbohn merged 2 commits into isofit:main from jammont:docs/mkdocs

Jan 22, 2026

.github/workflows/mkdocs.yml

-Original file line number
+Diff line change
@@ -0,0 +1,25 @@
+    name: MkDocs
+    on:
+      push:
+        branches:
+          - main
+    permissions:
+      contents: write
+    jobs:
+      deploy:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v6
+          - name: "Set up Python"
+            uses: actions/setup-python@v6
+            with:
+              python-version-file: "pyproject.toml"
+          - name: Install uv
+            uses: astral-sh/setup-uv@v7
+            with:
+              version: "0.9.25"
+          - run: uv sync
+          - run: uv run mkdocs gh-deploy --force

.gitignore

-Original file line number
+Diff line change
@@ Expand Up / @@ -3,12 +3,12 @@ @@
     *.egg*/
     *__pycache__/
-    # ISOFIT output directories
-    isotuts/NEON/*
-    !isotuts/NEON/*.ipynb
     # Jupyter server files
     .ipynb*/
     # MAC
     .DS_Store
+    # uv files
+    .python-version
+    uv.lock

docs/index.md

-Original file line number
+Diff line change
@@ -0,0 +1,9 @@
+    # ISOFIT Tutorials
+    Welcome to the ISOFIT tutorials repository! This repository contains a collection of Jupyter notebooks that serve as tutorials, examples, and further documentation for the ISOFIT project. These notebooks are designed to work seamlessly with the official ISOFIT Docker image, ensuring a hassle-free setup process.
+    ISOFIT is a powerful tool for atmospheric correction of remote sensing data, particularly hyperspectral data. These notebooks provide step-by-step guides and demonstrations on using ISOFIT for atmospheric correction, making it easier for users to understand and utilize the capabilities of the ISOFIT software.
+    ## License
+    The ISOFIT Tutorials project is licensed under the [Apache v2.0 License](https://opensource.org/license/apache-2-0/).

isotuts/Multisurface_ApplyOE/MultisurfaceApplyOE.ipynb

This file was deleted.

isotuts/NEON/data_prep.ipynb

This file was deleted.

isotuts/NEON/neon.ipynb

This file was deleted.

isotuts/NEON/neon_single_pixel.ipynb

This file was deleted.

isotuts/__init__.py

Empty file.

mkdocs.yml

-Original file line number
+Diff line change
@@ -0,0 +1,19 @@
+    site_name: ISOFIT Tutorials
+    repo_name: isofit/isofit-tutorials
+    repo_url: https://github.com/isofit/isofit-tutorials
+    docs_dir: docs/
+    theme:
+      name: readthedocs
+    plugins:
+      - search
+      - nbconvert:
+          execute_enabled: true
+          max_workers: 1
+          execute_options:
+            exit_on_error: false
+    nav:
+      - Home: index.md
+      - Notebooks:
+        - notebooks/apply_oe.md
+        - notebooks/neon.md
+        - notebooks/neon_single_pixel.md

Provide feedback