Allen-Synthesis / EuroPi

EuroPi: A reprogrammable Eurorack module based on the Raspberry Pi Pico
Creative Commons Zero v1.0 Universal
431 stars 84 forks source link

config doc #227

Closed mjaskula closed 1 year ago

mjaskula commented 1 year ago

The merge of the configuration system (PR #220) broke the docs build. This was because I forgot to update docs/api.rst when i renamed the module from config to configuration.

When I fixed that Sphinx gave me some indecipherable errors that I was only able to fix by upgrading things. It's nice to upgrade every now and then, though I'm not sure what actual advantages we are getting outside of a working build. I guess that's enough.

The broken build is here: https://github.com/Allen-Synthesis/EuroPi/actions/runs/4206970261/jobs/7301147434

An example corresponding fixed build on my branch is here: https://github.com/mjaskula/EuroPi/actions/runs/4207582150/jobs/7302546415

The newly build docs are here: https://mjaskula.github.io/EuroPi/generated/configuration.html