audeering / audobject

Generic Python interface for serializing objects to YAML
https://audeering.github.io/audobject/
Other
1 stars 0 forks source link

DOC: split up into sub-pages per class/function #66

Closed hagenw closed 1 year ago

hagenw commented 1 year ago

As discussed in https://github.com/audeering/audinterface/pull/86 this uses autosummary to split up the API documentation into several sub-pages, one for each function/class.

Also renamed Example to Examples in docstrings.

codecov[bot] commented 1 year ago

Codecov Report

Merging #66 (46cfa86) into main (ed4c4c7) will not change coverage. The diff coverage is n/a.

Impacted Files Coverage Δ
audobject/core/config.py 100.0% <ø> (ø)
audobject/core/dictionary.py 100.0% <ø> (ø)
audobject/core/object.py 100.0% <ø> (ø)
audobject/core/parameter.py 100.0% <ø> (ø)
audobject/core/resolver.py 100.0% <ø> (ø)
audobject/core/testing.py 100.0% <ø> (ø)
audobject/__init__.py 100.0% <0.0%> (ø)