search

Universite-Gustave-Eiffel / acoustic-toolbox

A Python library for acousticians.
https://acoustic-toolbox.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
7 stars 1 forks source link

Resolve docstring errors and transition to MkDocs #34

Closed MitchellAcoustics closed 3 weeks ago

MitchellAcoustics commented 3 weeks ago

Transitioning to mkdocs for documentation.

At current stage 7d116d0ce6a1962cd82c489acc555c58f0a9a156, the mkdocs is configured, and some pages and docstrings have been converted.

Ongoing work is to continue converting docstrings, then integrate jupyter notebooks, then reexamine the layout and organisation of the docs

MitchellAcoustics commented 3 weeks ago

This pull request is just to get the work onto the upstream repo, rather than my fork.