Scott Shawcroft
20dd3b1e43
Delete a bunch of docs, drivers and examples not relevant to CircuitPython.
...
This fixes #345 and fixes #215 .
2018-02-20 17:34:59 -08:00
Paul Sokolovsky
3f91570483
docs/library/usocket: Describe complete information on address formats.
...
Describe that the only portable way to deal with addresses is by using
getaddrinfo(). Describe that some ports may support tuple addresses using
"socket" module (vs "usocket" of native MicroPython).
2017-08-20 09:49:12 +03:00
Paul Sokolovsky
ccaad53270
docs/library/usocket: Move socket.error to its own section.
...
It's too minor a point to start the module description with it.
2017-08-20 09:04:48 +03:00
Paul Sokolovsky
465d84b7e7
docs/library: Add CPython docs xref to each pertinent module.
...
Cross-reference text/link is implemented as RST substitution, so easy to
consistently.
2017-07-02 15:37:31 +03:00
Paul Sokolovsky
1942f0ceef
docs/{framebuf,usocket}: Use markup adhering to the latest docs conventions.
2017-06-29 02:22:14 +03:00
Paul Sokolovsky
2e58474580
docs/usocket: Deconditionalize.
...
Notes on WiPy incompatibilities with the standard socket module API are
moved under "Known issues" to its documentation.
2017-04-09 00:48:28 +03:00
Paul Sokolovsky
6947a7f6a9
docs/usocket: Dedent Methods section.
...
This was apparently of an ::only directive which was later removed.
2017-01-28 15:49:54 +03:00
Paul Sokolovsky
f23c47fea7
docs/usocket: Clarify description of various methods.
2017-01-28 15:39:18 +03:00
Paul Sokolovsky
74fcb122f0
docs/usocket: Elaborate "Constants" section.
2017-01-28 14:46:58 +03:00
Paul Sokolovsky
59540dccf1
docs/usocket: Clarify exceptions used.
2017-01-28 13:55:51 +03:00
Paul Sokolovsky
a1a8f01799
docs/usocket: Clarify that socket timeout raises OSError exception.
2017-01-07 14:23:33 +03:00
Damien George
a392b3aa75
docs: Remove references to readall() and update stream read() docs.
2016-11-14 23:31:40 +11:00
Martin Müller
047ac2044d
docs/library: Fix typo in docs for usocket.listen().
2016-06-26 12:38:20 +01:00
Paul Sokolovsky
6e2fa5237d
docs/usocket: There must be empty line after .only:: .
2016-06-07 17:41:21 +03:00
Paul Sokolovsky
ae845f13de
docs: Use getaddrinfo() result in easy way.
...
Instead of extracting 4th element, extact last. Much easier to remember!
2016-05-03 00:48:04 +03:00
Paul Sokolovsky
df4e1d1279
docs/library: Consistently use admonitions for CPython differences.
2016-04-27 15:43:48 +03:00
Paul Sokolovsky
0d10e5310a
docs/usocket: Describe address format once at the beginning.
...
Different ports may have different formats.
2016-04-23 00:31:05 +03:00
Paul Sokolovsky
92497bff94
docs/usocket: socket.IPPROTO_SEC is WiPy-specific.
2016-04-23 00:17:34 +03:00
Paul Sokolovsky
955b8526f4
docs/usocket: Socket-specific exceptions are for WiPy only.
2016-04-23 00:17:09 +03:00
Paul Sokolovsky
71c6f93016
docs/library/usocket: Add link to CPython's socket module.
2016-04-23 00:08:43 +03:00
danicampora
04db848dc7
docs: Add usocket and ussl modules' documentation.
2015-10-21 15:30:56 +02:00
Damien George
a58713a899
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
Damien George
88d3054ac0
docs: Import documentation from source-code inline comments.
...
The inline docs (prefixed with /// in .c files) have been converted to
RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
