Skip to content

Commit

Permalink
Added automatic doc workflow
Browse files Browse the repository at this point in the history
Added automatic documentation workflows

Dummy commit to test workflow

Retried another workflow

Fixed typo in workflow

Fixed typo in dox generation action

Yet another try at deplay

Typo

Test

another try

anothen

Correct working dir?

anno

Added doxygen to build and deply

Correct

Correct path to Doxyfile?

Trying to find the correct folder

Moved to dox directory

Went a bit fast

Another try

Added platform on the gemfile

Added correct platform

Trying to fix setup ruby action

Trying to fix jekyll

Another try

Reverted gemlock

Another try

Try another workflow

Another

Another

Fixed upload artefact?

Spaces, not tab

Idem

Another try

Trying to fix the deploy

Dummy commit

Fixing doxygen

Trying to fix images

again

Trying a fix of images
  • Loading branch information
tomcombriat committed Dec 1, 2024
1 parent f6af592 commit 60d4e72
Show file tree
Hide file tree
Showing 7 changed files with 75 additions and 289 deletions.
69 changes: 69 additions & 0 deletions .github/workflows/build-and-deploy-site.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@

name: Deploy Jekyll site to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]


# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Doxygen Action
uses: mattnotmitt/[email protected]
with:
working-directory: extras/doxygen-style
doxyfile-path: Doxyfile
- name: Setup Ruby
uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0
with:
working-directory: gh-pages
ruby-version: '3.1' # Not needed with a .ruby-version file
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
cache-version: 0 # Increment this number if you need to re-download cached gems
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Build with Jekyll
# Outputs to the './_site' directory by default
working-directory: ./gh-pages
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
env:
JEKYLL_ENV: production
- name: Upload artifact
# Automatically uploads an artifact from the './_site' directory by default
uses: actions/upload-pages-artifact@v3
with:
path: ./gh-pages/_site

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 1 addition & 1 deletion ResonantFilter.h
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ fixed point version of the filter

enum filter_types { LOWPASS, BANDPASS, HIGHPASS, NOTCH };

/** A generic resonant filter for audio signals.
/** A generic resonant filter for audio signals TEST TEST.
*/
template<int8_t FILTER_TYPE, typename su=uint8_t>
class ResonantFilter
Expand Down
2 changes: 1 addition & 1 deletion extras/doxygen-style/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ PROJECT_LOGO = mozzi-circle.png
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.

OUTPUT_DIRECTORY = ../doc
OUTPUT_DIRECTORY = ../../gh-pages/doc

# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
Expand Down
283 changes: 0 additions & 283 deletions gh-pages/Gemfile.lock

This file was deleted.

4 changes: 2 additions & 2 deletions gh-pages/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ title : "Mozzi"
title_separator : "-"
name : "Mozzi Team"
description : "audio synthesis library for Arduino"
url : "https://sensorium.github.io" # the base hostname & protocol for your site e.g. "https://mmistakes.github.io"
url : "https://tomcombriat.github.io" # the base hostname & protocol for your site e.g. "https://mmistakes.github.io"
baseurl : "/Mozzi" # the subpath of your site, e.g. "/blog"
repository : "sensorium/Mozzi" # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes"
repository : "tomcombriat/Mozzi" # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes"
teaser : "" # path of fallback teaser image, e.g. "/assets/images/500x300.png"
# breadcrumbs : false # true, false (default)
words_per_minute : 200
Expand Down
2 changes: 1 addition & 1 deletion gh-pages/index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: single
toc: true
---

Currently your Arduino can only beep like a microwave oven. Mozzi brings
TESTEST Currently your Arduino can only beep like a microwave oven. Mozzi brings
your Arduino to life by allowing it to produce much more complex and interesting growls, sweeps and chorusing atmospherics. These sounds can be quickly and easily constructed from familiar synthesis units like oscillators, delays, filters and envelopes.

You can use Mozzi to generate algorithmic music for an installation or
Expand Down
Loading

0 comments on commit 60d4e72

Please sign in to comment.