Improving docs

All ESP8266 boards running MicroPython.
Official boards are the Adafruit Huzzah and Feather boards.
Target audience: MicroPython users with an ESP8266 board.
Post Reply
markxr
Posts: 62
Joined: Wed Jun 01, 2016 3:41 pm

Improving docs

Post by markxr » Wed Jun 01, 2016 9:48 pm

Hi,

Is there some way we could improve the docs? Can I clone the git repo and just send pull requests?

There seem to be some features which aren't documented at all (RTC memory, I found a bug in it, but the rtc ram wasn't documented in the esp8266 micropython, although it is documented on other esp8266 environments and quite useful).

Also I just found this setsockopt(socket.SOL_SOCKET, 20, callback_func) which sets a callback for a socket - which is potentially useful but totally undocumented.

User avatar
mcauser
Posts: 507
Joined: Mon Jun 15, 2015 8:03 am

Re: Improving docs

Post by mcauser » Thu Jun 02, 2016 1:19 am

Docs are managed in the repo, generated using sphinx, in the reStructuredText format and using Read The Docs styling.
https://github.com/micropython/micropyt ... aster/docs
http://www.sphinx-doc.org/en/stable/rest.html
http://read-the-docs.readthedocs.io/en/ ... arted.html

Post Reply