[📝] Autogenerate Documentation

.github/workflows/docs.yml

@@ -0,0 +1,53 @@
+# https://github.com/mitmproxy/pdoc/blob/main/.github/workflows/docs.yml
+
+name: PyHa Documentation
+
+# build the documentation whenever there are new commits on main
+on:
+  push:
+    branches:
+      - main
+      - np-generate-docs
+
+# security: restrict permissions for CI jobs.
+permissions:
+  contents: read
+
+jobs:
+  # Build the documentation and upload the static HTML files as an artifact.
+  build:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip poetry
+          poetry install
+
+      - name: Build Documentation
+        run: poetry run python -m pdoc ./PyHa --docformat google -o docs/
+        env:
+          PDOC_ALLOW_EXEC: 1
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/
+
+  # Deploy the artifact to GitHub pages.
+  # This is a separate job so that only actions/deploy-pages has the necessary permissions.
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -13,6 +13,8 @@ outputs/*
 /mixed_bird/*
 TEST/*
 
+docs/
+
 *.csv
 *.flac
 *.ipynb

PyHa/__init__.py

@@ -0,0 +1,7 @@
+r"""
+A tool designed to convert audio-based "weak" labels to "strong" moment-to-moment labels. Provides a pipeline to compare automated moment-to-moment labels to human labels. Current proof of concept work being fulfilled on Bird Audio clips using Microfaune predictions.
+
+This package is being developed and maintained by the [Engineers for Exploration Acoustic Species Identification Team](http://e4e.ucsd.edu/acoustic-species-identification) in collaboration with the [San Diego Zoo Wildlife Alliance](https://sandiegozoowildlifealliance.org/).
+
+PyHa = Python + Piha (referring to a bird species of our interest known as the screaming-piha)
+"""

pyproject.toml

@@ -61,3 +61,4 @@ tensorflow-io-gcs-filesystem = [
     { version = "< 0.32.0", markers = "platform_system == 'Windows'" }
 ]
 resampy = "^0.4.2"
+pdoc = "^14.4.0"