olivecha / guitarsounds

python library to analyse guitar sounds
MIT License
6 stars 0 forks source link

Source code in documentation out-of-sync #29

Closed cwitkowitz closed 1 year ago

cwitkowitz commented 1 year ago

The source code available in the "EXPAND SOURCE CODE" blocks of the documentation appears to be out of sync with the current code in the repository. I see these blocks are currently encoded manually in the html files under the docs folder. Is there any way to keep these blocks synchronized automatically?

olivecha commented 1 year ago

Hi, I will try and generate the documentation on push with a Github action!

olivecha commented 1 year ago

Alright, so the documentation at the link in the README.md is updated from the docs folder of the main branch for every push of the main branch. However, the html files in docs still need to be updated manually by using the command : $ pdoc -o docs guitarsounds

cwitkowitz commented 1 year ago

Nice, this is a huge improvement to workflow.