diff --git a/alsaaudio.c b/alsaaudio.c index 017e0fb..3087136 100644 --- a/alsaaudio.c +++ b/alsaaudio.c @@ -203,6 +203,12 @@ static bool is_value_volume_unit(long unit) return false; } +const char * const alsacard_list_doc = R"(.. function:: cards() -> list[str] + + List the available ALSA cards by name. This function is only moderately + useful. If you want to see a list of available PCM devices, use :func:`pcms` + instead.)"; + static PyObject * alsacard_list(PyObject *self, PyObject *args) { @@ -3079,7 +3085,7 @@ static PyTypeObject ALSAMixerType = { static PyMethodDef alsaaudio_methods[] = { { "card_indexes", (PyCFunction)alsacard_list_indexes, METH_VARARGS}, { "card_name", (PyCFunction)alsacard_name, METH_VARARGS}, - { "cards", (PyCFunction)alsacard_list, METH_VARARGS}, + { "cards", (PyCFunction)alsacard_list, METH_VARARGS, alsacard_list_doc }, { "pcms", (PyCFunction)alsapcm_list, METH_VARARGS|METH_KEYWORDS}, { "mixers", (PyCFunction)alsamixer_list, METH_VARARGS|METH_KEYWORDS}, { 0, 0 }, diff --git a/doc/conf.py b/doc/conf.py index 7212540..20b7a9a 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -34,7 +34,9 @@ from setup import pyalsa_version # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = ['autoapi.extension'] + +autoapi_dirs = ['..'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/doc/libalsaaudio.rst b/doc/libalsaaudio.rst index e7dacb9..f4c0c3e 100644 --- a/doc/libalsaaudio.rst +++ b/doc/libalsaaudio.rst @@ -34,12 +34,6 @@ The :mod:`alsaaudio` module defines functions and classes for using ALSA. *New in 0.8* -.. function:: cards() -> list[str] - - List the available ALSA cards by name. This function is only moderately - useful. If you want to see a list of available PCM devices, use :func:`pcms` - instead. - .. Omitted by intention due to being superseded by cards():