| 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 | |
| Chris Liechti | 2fb3404 | 2015-10-02 22:16:51 +0200 | [diff] [blame] | 6 | |
| cliechti | 5134aab | 2009-07-21 19:47:59 +0000 | [diff] [blame] | 7 | This module encapsulates the access for the serial port. It provides backends |
| Chris Liechti | 2fb3404 | 2015-10-02 22:16:51 +0200 | [diff] [blame] | 8 | for Python_ running on Windows, OSX, Linux, BSD (possibly any POSIX compliant |
| 9 | system) and IronPython. The module named "serial" automatically selects the |
| 10 | appropriate backend. |
| cliechti | c1c3760 | 2009-07-21 01:34:57 +0000 | [diff] [blame] | 11 | |
| cliechti | 8e814dc | 2009-07-30 22:19:08 +0000 | [diff] [blame] | 12 | Other pages (online) |
| 13 | |
| Chris Liechti | 90570b9 | 2015-08-04 03:32:02 +0200 | [diff] [blame] | 14 | - `project page on GitHub`_ |
| cliechti | 8e814dc | 2009-07-30 22:19:08 +0000 | [diff] [blame] | 15 | - `Download Page`_ with releases |
| Chris Liechti | 2fb3404 | 2015-10-02 22:16:51 +0200 | [diff] [blame] | 16 | - This page, when viewed online is at https://pyserial.readthedocs.org/en/latest/ or |
| 17 | http://pythonhosted.org/pyserial/ . |
| cliechti | 8e814dc | 2009-07-30 22:19:08 +0000 | [diff] [blame] | 18 | |
| Chris Liechti | 2a1befc | 2015-10-21 17:37:08 +0200 | [diff] [blame^] | 19 | .. _Python: http://python.org/ |
| Chris Liechti | 90570b9 | 2015-08-04 03:32:02 +0200 | [diff] [blame] | 20 | .. _`project page on GitHub`: https://github.com/pyserial/ |
| cliechti | 25375b5 | 2010-07-21 23:27:13 +0000 | [diff] [blame] | 21 | .. _`Download Page`: http://pypi.python.org/pypi/pyserial |
| cliechti | 8e814dc | 2009-07-30 22:19:08 +0000 | [diff] [blame] | 22 | |
| 23 | |
| cliechti | c1c3760 | 2009-07-21 01:34:57 +0000 | [diff] [blame] | 24 | Contents: |
| 25 | |
| 26 | .. toctree:: |
| 27 | :maxdepth: 2 |
| 28 | |
| 29 | pyserial |
| cliechti | c1c3760 | 2009-07-21 01:34:57 +0000 | [diff] [blame] | 30 | shortintro |
| cliechti | c1c3760 | 2009-07-21 01:34:57 +0000 | [diff] [blame] | 31 | pyserial_api |
| Chris Liechti | 589c92a | 2015-09-04 23:04:34 +0200 | [diff] [blame] | 32 | tools |
| 33 | url_handlers |
| 34 | examples |
| cliechti | c1c3760 | 2009-07-21 01:34:57 +0000 | [diff] [blame] | 35 | appendix |
| 36 | |
| 37 | Indices and tables |
| 38 | ================== |
| 39 | |
| 40 | * :ref:`genindex` |
| 41 | * :ref:`modindex` |
| 42 | * :ref:`search` |
| 43 | |