Online Documentation

All ESP8266 boards running MicroPython.
Official boards are the Adafruit Huzzah and Feather boards.
Target audience: MicroPython users with an ESP8266 board.
User avatar
deshipu
Posts: 1346
Joined: Thu May 28, 2015 5:54 pm

Online Documentation

Post by deshipu » Fri Mar 04, 2016 11:44 am

UPDATE: Current docs (may be outdated and lagging behind the latest development until GA release): http://micropython.org/resources/docs/e ... t/esp8266/

_____________________________________________________________


Hi,

now that this is going to be an official port, it would be nice to put the documentation online somewhere. I spent some time and effort to make it as up-to-date as possible some time ago (but I was unable to monitor all the commits for eventual changes, and since the developers happily change and move things around without updating the docs, you never know), however, due to the way it is compiled, I was unable to put it up on Read The Docs. The problem is that you have to pass a parameter to the make command to build for ESP8266, and Read The Docs doesn't support that.

I wonder if it would be possible to either do something that would allow putting it on Read The Docs, or to make it available together with the documentation of the other boards here.

Damien
Site Admin
Posts: 605
Joined: Mon Dec 09, 2013 5:02 pm

Re: Online Documentation

Post by Damien » Fri Mar 04, 2016 12:46 pm

Documentation is also available here: http://micropython.org/resources/docs/e ... t/esp8266/

That's more up-to-date than Read The Docs because it's compiled twice daily, and compiled for each port. The problem is it doesn't have the nice sidebar like RTD, with version selection, PDF download, etc. You also can't select the port (you must enter it in the URL manually). Once these things are fixed (they've been in my queue for a long time now...) then docs.micropython.org can link to these docs rather than RTD.

User avatar
deshipu
Posts: 1346
Joined: Thu May 28, 2015 5:54 pm

Re: Online Documentation

Post by deshipu » Fri Mar 04, 2016 2:47 pm

Thanks, I think this is enough for the time being, as long as people can find it here!

lapsule
Posts: 3
Joined: Thu Jan 07, 2016 2:09 am

Re: Online Documentation

Post by lapsule » Mon Mar 07, 2016 4:39 pm

Is there will be a separated domain name for this? it's hard to find .

pfalcon
Posts: 1153
Joined: Fri Feb 28, 2014 2:05 pm

Re: Online Documentation

Post by pfalcon » Tue Mar 08, 2016 5:28 am

deshipu, I'd like to assure you that docs are in the top scope of the work. So far however we didn't get to touch them yet, while running the campaign and having a feature accumulation sprint. Current docs would need to be largely rewritten for the new port.
Awesome MicroPython list
Pycopy - A better MicroPython https://github.com/pfalcon/micropython
MicroPython standard library for all ports and forks - https://github.com/pfalcon/micropython-lib
More up to date docs - http://pycopy.readthedocs.io/

Damien
Site Admin
Posts: 605
Joined: Mon Dec 09, 2013 5:02 pm

Re: Online Documentation

Post by Damien » Wed Mar 09, 2016 1:43 pm

All docs have now been moved from read-the-docs and placed on the dedicated MicroPython server. So now everything is available, up-to-date, at:

http://docs.micropython.org

In the side bar you can select the port and version of the docs that you need.

The source for these docs can be found in the docs/ directory of the main git repository. They are rebuilt every 12 hours and put online at the above URL.

SpotlightKid
Posts: 377
Joined: Wed Apr 08, 2015 5:19 am

Re: Online Documentation

Post by SpotlightKid » Wed Mar 09, 2016 5:02 pm

A few links on micropython.org are now broken:

- The "Quick-Ref" link in the site header, http://docs.micropython.org/en/latest/p ... ckref.html gives a 404.
- Also the "Tutorials" link in the site footer.
- Also all the links on http://micropython.org/help/

Damien
Site Admin
Posts: 605
Joined: Mon Dec 09, 2013 5:02 pm

Re: Online Documentation

Post by Damien » Wed Mar 09, 2016 5:58 pm

Thanks @SpotlightKid for reporting the broken links, they are now fixed!

User avatar
pythoncoder
Posts: 3366
Joined: Fri Jul 18, 2014 8:01 am
Location: UK
Contact:

Re: Online Documentation

Post by pythoncoder » Wed Mar 09, 2016 8:23 pm

Re "ports and versions" on the sidebar, the unix port gives a 404. On other ports if you select an old version, you lose the "ports and versions" section so you can't get back to the current version (via the sidebar).
Peter Hinch

Damien
Site Admin
Posts: 605
Joined: Mon Dec 09, 2013 5:02 pm

Re: Online Documentation

Post by Damien » Wed Mar 09, 2016 10:06 pm

pythoncoder wrote:Re "ports and versions" on the sidebar, the unix port gives a 404. On other ports if you select an old version, you lose the "ports and versions" section so you can't get back to the current version (via the sidebar).
unix 404 is now fixed, at least for the latest and v1.6 versions (earlier versions had an error in compiling the docs...). Regarding not having the sidebar for old versions, that's harder to fix because it requires patching the old versions to include this new feature!

Post Reply