New documentation website

Eomys / MoSQITo

MoSQITo is a unified and modular development framework of key sound quality metrics favoring reproducible science and efficient shared scripting among engineers, teachers and researchers community.

Apache License 2.0

134 stars 44 forks source link

New documentation website #73

Closed wantysal closed 8 months ago

wantysal commented 10 months ago

This version includes a new "docs" folder including all files necessary to generate html documentation pages based on the dosctring of each module using sphinx.

the docstring of all main functions has been updated to fit the template
some generic rst files have been written to replace the previous .md files
the conf.py file has been modified to create a customed html appearance

mglesser commented 8 months ago

Thanks for this major improvement of the repository !!!

A few comments after begining the review of the PR: Main page of the doc

[x] In "Publications citing MOSQITO" section, paper label can be removed
[x] In "Publications citing MOSQITO" section, the link to the papers needs to be checked

How to contribute page and Architecture page

[x] all first sentences after a title are in bold

API reference

[x] page names in the function documentation
[x] loudness_ecma documentation: label can be removed from the reference section

Review to be continued ...

mglesser commented 8 months ago

[x] loudness_zwst + loudness_zwst_freq + loudness_zwst_perseg: the standard ISO.532B-1:2017 should appear in the reference
[x] standard reference in the sq_metrics section should be modified
[x] pr_ecma_xx + tnr_ecma_xx : ECMA 418-1 should be cited in ref instead of ECMA 418-2

wantysal commented 8 months ago

Thanks for the review ! All comments have been considered, and the branch has been synchronized with master.

Need to check the uploading process before merging ;)