audeering / audpsychometric

Analyse rater annotations
Other
0 stars 0 forks source link

DOC: simplify API documentation #14

Closed hagenw closed 2 months ago

hagenw commented 2 months ago

Removes audpsychometric.datasets sub-module, and flatten hierachy in API documentation:

image

The documentation, that listed the available datasets was moved to the examples in the docstring:

image

And we also show an example dataset now:

image

hagenw commented 2 months ago

When building the docs locally, I see that there is a dfiference between the github action and CONTRIBUTING.rst.

I wonder whether there is a reason for that?

python -m sphinx docs/ docs/_build/ -b html -W
python -m sphinx docs/ build/sphinx/html -b html

I changed it to

python -m sphinx docs/ build/html -b html

and

python -m sphinx docs/ build/html -b html -W

to use the same build folder.

The additional -W in the Github action let's the test fails (raise error for warning), which you usually don't want when building locally.