| cliechti | 5134aab | 2009-07-21 19:47:59 +0000 | [diff] [blame] | 1 | .. pySerial documentation master file |
| cliechti | c1c3760 | 2009-07-21 01:34:57 +0000 | [diff] [blame] | 2 | |
| cliechti | 5134aab | 2009-07-21 19:47:59 +0000 | [diff] [blame] | 3 | Welcome to pySerial's documentation |
| 4 | =================================== |
| 5 | |
| 6 | This module encapsulates the access for the serial port. It provides backends |
| 7 | for Python running on Windows, Linux, BSD (possibly any POSIX compliant |
| 8 | system), Jython and IronPython (.NET and Mono). The module named "serial" |
| 9 | automatically selects the appropriate backend. |
| cliechti | c1c3760 | 2009-07-21 01:34:57 +0000 | [diff] [blame] | 10 | |
| cliechti | 8e814dc | 2009-07-30 22:19:08 +0000 | [diff] [blame] | 11 | Other pages (online) |
| 12 | |
| Chris Liechti | 90570b9 | 2015-08-04 03:32:02 +0200 | [diff] [blame] | 13 | - `project page on GitHub`_ |
| cliechti | 8e814dc | 2009-07-30 22:19:08 +0000 | [diff] [blame] | 14 | - `Download Page`_ with releases |
| Chris Liechti | 90570b9 | 2015-08-04 03:32:02 +0200 | [diff] [blame] | 15 | - This page, when viewed online, is at http://pythonhosted.org/pyserial/ . |
| cliechti | 8e814dc | 2009-07-30 22:19:08 +0000 | [diff] [blame] | 16 | |
| Chris Liechti | 90570b9 | 2015-08-04 03:32:02 +0200 | [diff] [blame] | 17 | .. _`project page on GitHub`: https://github.com/pyserial/ |
| cliechti | 25375b5 | 2010-07-21 23:27:13 +0000 | [diff] [blame] | 18 | .. _`Download Page`: http://pypi.python.org/pypi/pyserial |
| cliechti | 8e814dc | 2009-07-30 22:19:08 +0000 | [diff] [blame] | 19 | |
| 20 | |
| cliechti | c1c3760 | 2009-07-21 01:34:57 +0000 | [diff] [blame] | 21 | Contents: |
| 22 | |
| 23 | .. toctree:: |
| 24 | :maxdepth: 2 |
| 25 | |
| 26 | pyserial |
| cliechti | c1c3760 | 2009-07-21 01:34:57 +0000 | [diff] [blame] | 27 | shortintro |
| cliechti | 86e8787 | 2009-07-21 13:32:45 +0000 | [diff] [blame] | 28 | examples |
| cliechti | c1c3760 | 2009-07-21 01:34:57 +0000 | [diff] [blame] | 29 | pyserial_api |
| cliechti | c1c3760 | 2009-07-21 01:34:57 +0000 | [diff] [blame] | 30 | appendix |
| 31 | |
| 32 | Indices and tables |
| 33 | ================== |
| 34 | |
| 35 | * :ref:`genindex` |
| 36 | * :ref:`modindex` |
| 37 | * :ref:`search` |
| 38 | |