Improved docs - Githubissues

v0lta / PyTorch-Wavelet-Toolbox

Differentiable fast wavelet transforms in PyTorch with GPU support.

https://pytorch-wavelet-toolbox.readthedocs.io

European Union Public License 1.2

279 stars 36 forks source link

Closed v0lta closed 6 months ago

v0lta commented 9 months ago

TODO:

adopt the sphinx_book_theme (done)
add an introduction explaining how wavelets work ( in progress)
improve the function docstrings by adding appropriate formulae.
finish the 1D-swt code
- see also: https://github.com/v0lta/PyTorch-Wavelet-Toolbox/issues/74

The following terminal commands render the documentation:

cd docs
make html

The docs depend on the sphinx-book-theme and sphinxcontrib-bibtex pip packages.

v0lta commented 8 months ago

@kgasenzer merci :-).

v0lta commented 6 months ago

Docs update done.