First working version

.github/workflows/build_docs.yml

@@ -0,0 +1,41 @@
+name: Build Docs
+
+on:
+  push:
+    branches: ["main", "dev"]
+
+jobs:
+  build-docs:
+     runs-on: ubuntu-latest
+     steps:
+      - uses: actions/checkout@v4
+      - id: setup-python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+            virtualenvs-create: true
+            virtualenvs-in-project: true
+            installer-parallel: true
+
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v3
+        with:
+            path: .venv
+            key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}          
+
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --no-interaction --no-root --with docs
+      - name: Quardo Doc Build
+        run: |
+            quartodoc build --config doc/_quarto.yml
+      - uses: quarto-dev/quarto-actions/setup@v2
+      - name: Render and publish to gh pages
+        uses: quarto-dev/quarto-actions/publish@v2
+        with:
+          target: gh-pages
+          path: docs

.gitignore

@@ -158,3 +158,6 @@ cython_debug/
 #  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/
+
+notebooks/
+docs/_site

README.md

@@ -1,2 +1,3 @@
 # fave-syllabify
+![Static Badge](https://img.shields.io/badge/%E2%9A%A0%EF%B8%8F-work_in_progress-red)
 Syllabify a force-aligned TextGrid

docs/.gitignore

@@ -0,0 +1 @@
+/.quarto/

docs/_quarto.yml

@@ -4,11 +4,36 @@ project:
 
 license: GPLv3
 
+website:
+  page-navigation: true
+  navbar:
+    logo: assets/logo.png
+    left:
+      - file: index.qmd
+        text: Get Started
+      - href: reference/
+        text: Reference
+
+format:
+  html: 
+    theme:
+      light: flatly
+      dark: darkly
+    toc: true
+
+# tell quarto to read the generated sidebar
+metadata-files:
+  - reference/_sidebar.yml
+
 quartodoc:
   # the name used to import the package you want to create reference docs for
-  package: aligned_textgrid
+  package: fave_syllabify
   style: pkgdown
   dir: reference
   # write sidebar data to this file
   sidebar: "reference/_sidebar.yml"
   parser: google
+  sections:
+    - title: Reference
+      contents:
+        - syllabify