Documentation not updating properly about autoanalogaudio HOT 7 CLOSED

was it only displaying the README before?

Yeah, now working again.

from autoanalogaudio.

Docs are only updated on release events. If you want to work around this (without doing a release), you could comment out this line in .github/workflows/doxygen.yml (using # this is a yml comment). Beware that every commit on the master branch (including open pull requests) will update the docs when that line is commented out.

from autoanalogaudio.

I will also defer to my latest PR on RF24Audio because that repo is also setup to update the docs on every commit to master, but notice the doxygen workflow fails because my fork has no permission to update upstream/gh-pages branch

from autoanalogaudio.

ok something is weird with this repo. @TMRh20 could you confirm that the repo settings are using the root directory of the gh-pages branch? It looks like the gh-pages branch is correct.

from autoanalogaudio.

I just created the gh-pages branch today in attempts to get it working. It is set to that now.

from autoanalogaudio.

was it only displaying the README before? ok docs are now properly deployed.

I also noticed some problems with the Doxyfile concerning the INPUT and RECURSIVE tags. They should probably be

INPUT                  = ./src/AutoAnalogAudio.h \
                         ./src/ESP32/AutoAnalogAudio.cpp

and

RECURSIVE              = NO

Also, the wavStruct used in one of the examples is also getting documented in the classes list. The above changes fix that

from autoanalogaudio.

Diving deeper into the documented API, I noticed that the ramp*() methods weren't getting documented because of the #if defined ESP32 condition. I've started using a special macro defined by Doxyfile to force inclusion of some platform specific functionality.

Probably needles to say, but I'll submit a PR to address these doc problems

from autoanalogaudio.