Merge pull request #3 from hgloeckner/add_build

add automatic build (and hopefully deploy)

.github/workflows/build_and_deploy.yml

@@ -0,0 +1,37 @@
+name: build_and_deploy
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -l {0}
+    steps:
+    - uses: actions/checkout@v4
+    - name: initialize conda
+      uses: conda-incubator/setup-miniconda@v3
+      with:
+        activate-environment: pydropsonde_env
+        auto-activate-base: false
+        use-mamba: true
+        miniforge-variant: Mambaforge
+        miniforge-version: latest
+    - name: install conda environment
+      run:
+          mamba env update -n pydropsonde_env -f environment.yaml
+    - name: Sphinx build
+      run:
+          sphinx-build -W docs/source docs/_build --keep-going
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+      with:
+        publish_branch: gh-pages
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: _build/
+        force_orphan: true

.github/workflows/python-package.yml

@@ -1,11 +1,11 @@
-# This workflow will install Python dependencies using mamba, run tests and check pre-commit
+## This workflow will install Python dependencies using mamba, run tests and check pre-commit
 
 name: Python package
 
 on: [push, pull_request]
 
 jobs:
-  build:
+  test:
 
     runs-on: ubuntu-latest
     strategy:
@@ -23,13 +23,10 @@ jobs:
         init-shell: bash
         generate-run-shell: true
         environment-name: testenv
-        environment-file: environment.yml
+        environment-file: environment.yaml
     - name: pre-commit
       uses: pre-commit/action@v3.0.0
     - name: Run pytest in micromamba environment
       run: |
         micromamba install -n testenv pytest
         micromamba run -n testenv pytest --import-mode=importlib .
-    - name: Build docs
-      run: |
-        micromamba run -n testenv sphinx-build -n -b html docs/source/ docs/build/

.gitignore

@@ -29,7 +29,8 @@ halodrops_env/
 
 # Sphinx documentation
 docs/build/
-
+**/_autosummary
+**/_build
 # Visual Studio Code
 .vscode/*
 

docs/source/api.rst

@@ -0,0 +1,8 @@
+API
+===
+
+.. autosummary::
+   :toctree: _autosummary
+   :recursive:
+
+   pydropsonde