Updates for release 0.3:

setup.py was extended for pypi.

doc/index.html is automatically rewritten by doc/src/Makefile to add 
SourceForge links. index.html is now the standard homepage for pyalsaaudio.

Minor documentation fixes (capitalisation, spelling, etc.). Caspers email is 
hidden in the documentation.


git-svn-id: svn://svn.code.sf.net/p/pyalsaaudio/code/trunk@14 ec2f30ec-7544-0410-870e-f70ca00c83f0
This commit is contained in:
larsimmisch
2008-01-24 12:30:46 +00:00
parent fa12a62e57
commit 2cf24ef81b
27 changed files with 678 additions and 588 deletions

View File

@@ -5,7 +5,8 @@
#
# You also need a working latex installation, and the latex2html
# tool installed.
PYTHONSOURCE = /usr/src/Python-2.4.1/
PYTHONSOURCE = /usr/local/src/Python-2.5.1/
SFUSER = larsimmisch
# Shouldn't need to change anything below here!
@@ -13,8 +14,10 @@ MKHOWTO = $(PYTHONSOURCE)/Doc/tools/mkhowto
all:
$(MKHOWTO) --dir .. --html pyalsaaudio.tex
python sffixup.py ../index.html
text:
$(MKHOWTO) --dir .. --text pyalsaaudio.tex
install:
scp ../*.html ../*.gif ../*.png $(SFUSER)@shell.sourceforge.net:/home/groups/p/py/pyalsaaudio/htdocs

View File

@@ -5,7 +5,7 @@
\platform{Linux}
\moduleauthor{Casper Wilstrup}{cwi@unispeed.com} % Author of the module code;
\moduleauthor{Casper Wilstrup} % {cwi@aves.dk} % Author of the module code;
\modulesynopsis{ALSA sound support}
@@ -31,7 +31,7 @@ ALSA.
\begin{funcdesc}{mixers}{\optional{cardname}}
List the available mixers. The optional \var{cardname} specifies which
card should be queried (this is only relevant if you have more than one
sound card). Omit to use the default sound card
sound card). Omit to use the default sound card.
\end{funcdesc}
\begin{classdesc}{PCM}{\optional{type}, \optional{mode}, \optional{cardname}}
@@ -247,7 +247,7 @@ periods by calling write a couple of times, and then use some timer method to wr
the device every period. The purpose of the preloading is to avoid underrun clicks if the used timer
doesn't expire exactly on time.
Also note, that most timer API's that you can find for Python will cummulate time delays: If you set the timer
Also note, that most timer APIs that you can find for Python will cummulate time delays: If you set the timer
to expire after 1/10'th of a second, the actual timeout will happen slightly later, which will accumulate to
quite a lot after a few seconds. Hint: use time.time() to check how much time has really passed, and add
extra writes as nessecary.

View File

@@ -2,12 +2,13 @@
\title{PyAlsaAudio}
\release{0.2}
\release{0.3}
% At minimum, give your name and an email address. You can include a
% snail-mail address if you like.
\author{Casper Wilstrup}
\authoraddress{cwi@unispeed.com}
% Commented out for now - Lars
% \authoraddress{cwi@aves.dk}
\begin{document}
\maketitle
@@ -29,13 +30,13 @@ whatsoever.
% scope of the document.
\begin{abstract}
\noindent
This package contains wrappers for accessing the ALSA api from Python. It
This package contains wrappers for accessing the ALSA API from Python. It
is currently fairly complete for PCM devices and Mixer access. MIDI sequencer
support is low on my priority list, but volunteers are welcome.
If you find bugs in the wrappers please notify me on email. Please
If you find bugs in the wrappers please use the SourceForge bug tracker. Please
don't send bug reports regarding ALSA specifically. There are several
bugs in this api, and those should be reported to the ALSA team - not
bugs in this API, and those should be reported to the ALSA team - not
me.
\end{abstract}

35
doc/src/sffixup.py Normal file
View File

@@ -0,0 +1,35 @@
#!/usr/bin/env/python
# This is a hack and totally brittle. Let's not talk about it.
import sys
sfnotes = '''<ul>
<li><a href="http://sourceforge.net/">SourceForge</li>
<ul>
<li><a href="http://sourceforge.net/projects/pyalsaaudio/">Summary page</a>
<li><a href="http://sourceforge.net/project/showfiles.php?group_id=120651">Download</a>
<li><a href="http://sourceforge.net/tracker/?group_id=120651">Bug Tracker</a>
</ul>
</ul>'''
if len(sys.argv) <= 1:
print "usage: sffixup.py <file>"
sys.exit(2)
f = open(sys.argv[1], 'r')
lines = f.readlines()
f.close()
try:
index = lines.index('<a name="CHILD_LINKS"></a>\n')
except ValueError:
print "Cannot find child links. SourceForge links will not appear on index.html."
sys.exit(1)
lines.insert(index, sfnotes)
f = open(sys.argv[1], 'w')
for l in lines:
f.write(l)
f.close()