Skip to content

Commit fb8ca29

Browse files
committed
Docs: add a separate page with examples
1 parent 98cc165 commit fb8ca29

File tree

3 files changed

+18
-14
lines changed

3 files changed

+18
-14
lines changed

README.rst

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -213,17 +213,3 @@ Blocking Read/Write Streams
213213
^^^^^^^^^^^^^^^^^^^^^^^^^^^
214214

215215
Coming soon!
216-
217-
More Examples
218-
^^^^^^^^^^^^^
219-
220-
Have a look in the ``examples/`` directory.
221-
222-
Copyright Information
223-
---------------------
224-
225-
python-sounddevice (MIT License)
226-
Copyright (c) 2015 Matthias Geier
227-
228-
PortAudio_ Portable Real-Time Audio Library (MIT License)
229-
Copyright (c) 1999-2011 Ross Bencina and Phil Burk

doc/examples.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:orphan:
2+
3+
Example Program(s)
4+
==================
5+
6+
Play a Sound File
7+
-----------------
8+
9+
:download:`play_file.py <../examples/play_file.py>`
10+
11+
.. literalinclude:: ../examples/play_file.py

doc/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
.. include:: ../README.rst
44

5+
.. only:: html
6+
7+
More Examples
8+
^^^^^^^^^^^^^
9+
10+
For more examples, have a look at the :doc:`examples`.
11+
512
.. include:: ../CONTRIBUTING.rst
613

714
.. default-role::

0 commit comments

Comments
 (0)