1.. pySerial documentation master file
2.. _welcome:
3
4Welcome to pySerial's documentation
5===================================
6
7
8This module encapsulates the access for the serial port. It provides backends
9for Python_ running on Windows, OSX, Linux, BSD (possibly any POSIX compliant
10system) and IronPython. The module named "serial" automatically selects the
11appropriate backend.
12
13Other pages (online)
14
15- `project page on GitHub`_
16- `Download Page`_ with releases
17- This page, when viewed online is at https://pyserial.readthedocs.io/en/latest/ or
18  http://pythonhosted.org/pyserial/ .
19
20.. _Python: http://python.org/
21.. _`project page on GitHub`: https://github.com/pyserial/
22.. _`Download Page`: http://pypi.python.org/pypi/pyserial
23
24
25Contents:
26
27.. toctree::
28    :maxdepth: 2
29
30    pyserial
31    shortintro
32    pyserial_api
33    tools
34    url_handlers
35    examples
36    appendix
37
38Indices and tables
39==================
40
41* :ref:`genindex`
42* :ref:`modindex`
43* :ref:`search`
44
45