Docs PDF Functionality

General discussions and questions abound development of code with MicroPython that is not hardware specific.
Target audience: MicroPython Users.
Post Reply
bbk_underwater
Posts: 2
Joined: Tue Feb 13, 2018 5:48 pm

Docs PDF Functionality

Post by bbk_underwater » Tue Feb 13, 2018 6:06 pm

-I'm on the go, away from the internet often (travel, at sea, etc) and was looking to grab the PDF version off of the MicroPython docs site (http://docs.micropython.org).

-The Sphinx/Read the Docs setup appears to offer a PDF download as an option in the menu on the lower left - I'd really appreciate a PDF reference in the future to throw on my machine when leaving civilization and the internet.

-The PDF link there 404s (http://docs.micropython.org/en/latest/m ... yboard.pdf).

*Is there a good way to generate this on my own, or does this need intervention from administrators of the doc site?

*Is there a good, equivalent source for comprehensive MicroPython documentation elsewhere?

fdufnews
Posts: 29
Joined: Mon Jul 25, 2016 11:31 am

Re: Docs PDF Functionality

Post by fdufnews » Tue Feb 13, 2018 7:49 pm

In the ReadTheDoc the latest is the default selection and the pdf link exits with a 404 error but if you select the 1.9.3 release you'll have a pdf. Don't forget to select the right platform first.

bbk_underwater
Posts: 2
Joined: Tue Feb 13, 2018 5:48 pm

Re: Docs PDF Functionality

Post by bbk_underwater » Thu Feb 22, 2018 12:33 am

Thank you! I had to go back to 1.9.2, but that got me a rather useful PDF version of the Docs that I can take offline with me.

Deedee
Posts: 3
Joined: Thu Jan 24, 2019 3:31 pm

Re: Docs PDF Functionality

Post by Deedee » Sat Jul 06, 2019 1:56 pm

Hi there,

it seems the V1.11 PDF documentation is crippled as well.

Apart from the regular "latest" link to the PDF doc throwing a "MicroPython Documentation Not Found!",
I managed to load e V1.11 bit it is only 181 pages and ends i the middle of Ch4.

I really appreciate the gorgeous work you do to write it and I also need to take it with me while travelling as reference.
In mean time I'm using V1.10, but V1.11 has some improvements I like.

Thank you.
Best,
D

User avatar
jimmo
Posts: 2053
Joined: Tue Aug 08, 2017 1:57 am
Location: Sydney, Australia
Contact:

Re: Docs PDF Functionality

Post by jimmo » Sun Jul 07, 2019 6:26 am

Note sure why the website link is broken, I generated a copy locally and uploaded it to Google Drive -- https://drive.google.com/file/d/1HXz0UE ... sp=sharing

If you want to access the docs offline, you might prefer to use the HTML version rather than PDF. In which case you can generate the HTML version yourself using Sphinx. See https://github.com/micropython/micropyt ... /README.md

Post Reply