mirror of
https://github.com/larsimmisch/pyalsaaudio.git
synced 2026-04-16 16:15:31 +00:00
drop some pointless comments from the tex => sphinx conversion
amends 5c2a00655.
This commit is contained in:
@@ -1,8 +1,3 @@
|
||||
.. alsaaudio documentation documentation master file, created by
|
||||
sphinx-quickstart on Thu Mar 30 23:52:21 2017.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
alsaaudio documentation
|
||||
===================================================
|
||||
|
||||
@@ -34,5 +29,3 @@ Indices and tables
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -5,34 +5,11 @@
|
||||
.. module:: alsaaudio
|
||||
:platform: Linux
|
||||
|
||||
|
||||
.. % \declaremodule{builtin}{alsaaudio} % standard library, in C
|
||||
.. % not standard, in C
|
||||
|
||||
.. moduleauthor:: Casper Wilstrup <cwi@aves.dk>
|
||||
.. moduleauthor:: Lars Immisch <lars@ibp.de>
|
||||
|
||||
.. % Author of the module code;
|
||||
|
||||
|
||||
|
||||
The :mod:`alsaaudio` module defines functions and classes for using ALSA.
|
||||
|
||||
.. % ---- 3.1. ----
|
||||
.. % For each function, use a ``funcdesc'' block. This has exactly two
|
||||
.. % parameters (each parameters is contained in a set of curly braces):
|
||||
.. % the first parameter is the function name (this automatically
|
||||
.. % generates an index entry); the second parameter is the function's
|
||||
.. % argument list. If there are no arguments, use an empty pair of
|
||||
.. % curly braces. If there is more than one argument, separate the
|
||||
.. % arguments with backslash-comma. Optional parts of the parameter
|
||||
.. % list are contained in \optional{...} (this generates a set of square
|
||||
.. % brackets around its parameter). Arguments are automatically set in
|
||||
.. % italics in the parameter list. Each argument should be mentioned at
|
||||
.. % least once in the description; each usage (even inside \code{...})
|
||||
.. % should be enclosed in \var{...}.
|
||||
|
||||
|
||||
.. function:: pcms(pcmtype=PCM_PLAYBACK)
|
||||
|
||||
List available PCM devices by name.
|
||||
@@ -614,8 +591,6 @@ Unfortunately, I'm not able to create such a HOWTO myself, since I only
|
||||
understand half of the API, and that which I do understand has come from a
|
||||
painful trial and error process.
|
||||
|
||||
.. % ==== 4. ====
|
||||
|
||||
|
||||
.. _pcm-example:
|
||||
|
||||
|
||||
@@ -7,26 +7,12 @@ Introduction
|
||||
|
||||
.. |release| replace:: version
|
||||
|
||||
.. % At minimum, give your name and an email address. You can include a
|
||||
.. % snail-mail address if you like.
|
||||
|
||||
.. % This makes the Abstract go on a separate page in the HTML version;
|
||||
.. % if a copyright notice is used, it should go immediately after this.
|
||||
.. %
|
||||
|
||||
|
||||
.. _front:
|
||||
|
||||
This software is licensed under the PSF license - the same one used by the
|
||||
majority of the python distribution. Basically you can use it for anything you
|
||||
wish (even commercial purposes). There is no warranty whatsoever.
|
||||
|
||||
.. % Copyright statement should go here, if needed.
|
||||
|
||||
.. % The abstract should be a paragraph or two long, and describe the
|
||||
.. % scope of the document.
|
||||
|
||||
|
||||
.. topic:: Abstract
|
||||
|
||||
This package contains wrappers for accessing the ALSA API from Python. It is
|
||||
|
||||
Reference in New Issue
Block a user