search

iver56 / audiomentations

A Python library for audio data augmentation. Inspired by albumentations. Useful for machine learning.
https://iver56.github.io/audiomentations/
MIT License
1.82k stars 187 forks source link

Question about documentation creation #330

Closed atamazian closed 7 months ago

atamazian commented 7 months ago

I'd like to ask how is the documentation created - manually, or with usage of some tools like doxygen?

iver56 commented 7 months ago

Documentation is made manually in the form of markdown files here: https://github.com/iver56/audiomentations/tree/main/docs

Waveform transform pages should ideally have an example with waveform & spectrogram before and after, as well as playable audio before and after. Those can be made with the following script: https://github.com/iver56/audiomentations/blob/main/demo/generate_examples_for_doc.py

Github Actions compiles it to a website, using mkdocs-material, and deploys it on Github Pages

Contributions to the documentation, like adding pages for Bitcrush and Aliasing, are welcome 👍 If you have more question, I'd be happy to answer them