feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5
|
Last change
on this file since 8986239 was
152bf4f,
checked in by Paul Brossier <piem@piem.org>, 6 years ago
|
|
[doc] start adding autodoc to sphinx documents
|
-
Property mode set to
100644
|
|
File size:
472 bytes
|
| Rev | Line | |
|---|
| [152bf4f] | 1 | .. make sure our default-domain is python here |
|---|
| 2 | .. default-domain:: py |
|---|
| 3 | |
|---|
| 4 | .. set current module |
|---|
| 5 | .. currentmodule:: aubio |
|---|
| 6 | |
|---|
| 7 | .. |
|---|
| 8 | we follow numpy type docstrings, see: |
|---|
| 9 | https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard |
|---|
| 10 | |
|---|
| 11 | Python documentation |
|---|
| 12 | ==================== |
|---|
| 13 | |
|---|
| 14 | |
|---|
| 15 | .. midiconv.py |
|---|
| 16 | |
|---|
| 17 | .. autofunction:: note2midi |
|---|
| 18 | |
|---|
| 19 | .. autofunction:: midi2note |
|---|
| 20 | |
|---|
| 21 | .. autofunction:: freq2note |
|---|
| 22 | |
|---|
| 23 | .. autofunction:: note2freq |
|---|
| 24 | |
|---|
| 25 | .. slicing.py |
|---|
| 26 | |
|---|
| 27 | .. autofunction:: slice_source_at_stamps |
|---|
Note: See
TracBrowser
for help on using the repository browser.
