Skip to content

Commit 6ac15b5

Browse files
committed
DOC: minor documentation changes
1 parent 545f0b5 commit 6ac15b5

File tree

3 files changed

+20
-12
lines changed

3 files changed

+20
-12
lines changed

CONTRIBUTING.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Contributing
33

44
If you find bugs, errors, omissions or other things that need improvement,
55
please create an issue or a pull request at
6-
http://github.com/spatialaudio/python-sounddevice/.
6+
https://github.com/spatialaudio/python-sounddevice/.
77
Contributions are always welcome!
88

99
Instead of pip-installing the latest release from PyPI, you should get the
@@ -13,7 +13,7 @@ newest development version from Github_::
1313
cd python-sounddevice
1414
python3 setup.py develop --user
1515

16-
.. _Github: http://github.com/spatialaudio/python-sounddevice/
16+
.. _Github: https://github.com/spatialaudio/python-sounddevice/
1717

1818
This way, your installation always stays up-to-date, even if you pull new
1919
changes from the Github repository.

NEWS.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
* `sounddevice.playrec()`: Rename the arguments *input_channels* and
5555
*input_dtype* to *channels* and *dtype*, respectively
5656

57-
.. _PySoundFile: https://github.com/bastibe/PySoundFile/
57+
.. _PySoundFile: https://github.com/bastibe/SoundFile/
5858

5959
0.1.0 (2015-06-20):
6060
Initial release. Some ideas are taken from PySoundCard_. Thanks to Bastian

README.rst

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Documentation:
88
http://python-sounddevice.readthedocs.io/
99

1010
Source code repository and issue tracker:
11-
http://github.com/spatialaudio/python-sounddevice/
11+
https://github.com/spatialaudio/python-sounddevice/
1212

1313
License:
1414
MIT -- see the file ``LICENSE`` for details.
@@ -33,11 +33,15 @@ pip/setuptools:
3333
Those are needed for the installation of the Python module and its
3434
dependencies. Most systems will have these installed already, but if not,
3535
you should install it with your package manager or you can download and
36-
install pip and setuptools as described on the `pip installation`_ page.
37-
If you happen to have pip but not setuptools, use this command::
36+
install ``pip`` and ``setuptools`` as described on the `pip installation`_
37+
page.
38+
If you happen to have ``pip`` but not ``setuptools``, use this command::
3839

3940
python3 -m pip install setuptools --user
4041

42+
To upgrade to a newer version of an already installed package (including
43+
``pip`` itself), use the ``--upgrade`` flag.
44+
4145
CFFI:
4246
The `C Foreign Function Interface for Python`_ is used to access the C-API
4347
of the PortAudio library from within Python. It supports CPython 2.6, 2.7,
@@ -63,17 +67,19 @@ NumPy (optional):
6367
NumPy at all.
6468
If you need NumPy, you should install it with your package manager or use a
6569
Python distribution that already includes NumPy (see above).
66-
Installing NumPy with pip requires a compiler and several additional
67-
libraries and is therefore not recommended for beginners.
70+
You can also install NumPy with ``pip``, but depending on your platform, this
71+
might require a compiler and several additional libraries::
72+
73+
python3 -m pip install NumPy --user
6874

6975
.. _PortAudio: http://www.portaudio.com/
7076
.. _NumPy: http://www.numpy.org/
71-
.. _Python: http://www.python.org/
72-
.. _Anaconda: http://docs.continuum.io/anaconda/
77+
.. _Python: https://www.python.org/
78+
.. _Anaconda: https://www.anaconda.com/download/
7379
.. _WinPython: http://winpython.github.io/
7480
.. _C Foreign Function Interface for Python: http://cffi.readthedocs.io/
7581
.. _PyPy: http://pypy.org/
76-
.. _pip installation: http://www.pip-installer.org/en/latest/installing.html
82+
.. _pip installation: https://pip.pypa.io/en/latest/installing/
7783

7884
Installation
7985
------------
@@ -85,13 +91,15 @@ to download and install the latest release with a single command::
8591

8692
If you want to install it system-wide for all users (assuming you have the
8793
necessary rights), you can just drop the ``--user`` option.
94+
If you have installed the module already, you can use the ``--upgrade`` flag to
95+
get the newest release.
8896

8997
To un-install, use::
9098

9199
python3 -m pip uninstall sounddevice
92100

93101
If you are using Windows, you can alternatively install one of the packages
94-
provided at http://www.lfd.uci.edu/~gohlke/pythonlibs/#sounddevice.
102+
provided at https://www.lfd.uci.edu/~gohlke/pythonlibs/#sounddevice.
95103
The PortAudio library is also included in the package and you can get the rest
96104
of the dependencies on the same page.
97105

0 commit comments

Comments
 (0)