Where is correct doc source?

General discussions and questions abound development of code with MicroPython that is not hardware specific.
Target audience: MicroPython Users.
Post Reply
hlovatt
Posts: 50
Joined: Thu Aug 15, 2019 3:52 am
Location: Sydney

Where is correct doc source?

Post by hlovatt » Wed Jul 01, 2020 12:41 am

Where is the correct location for the MicroPython docs source files, I can find two:
  1. https://docs.micropython.org/en/latest/ ... s/library/
  2. https://raw.githubusercontent.com/micro ... s/library/
Which is the correct source?

gatorchu
Posts: 24
Joined: Sun Sep 22, 2019 3:50 pm

Re: Where is correct doc source?

Post by gatorchu » Wed Jul 01, 2020 1:27 am

Seems like the first one is the official one.

User avatar
dhylands
Posts: 3415
Joined: Mon Jan 06, 2014 6:08 pm
Location: Peachland, BC, Canada
Contact:

Re: Where is correct doc source?

Post by dhylands » Wed Jul 01, 2020 6:17 pm

I think its the second one, which is really just a frontend for: https://github.com/micropython/micropyt ... cs/library

The first one, should be a "rendering" of whatever is found in the github repository.

hlovatt
Posts: 50
Joined: Thu Aug 15, 2019 3:52 am
Location: Sydney

Re: Where is correct doc source?

Post by hlovatt » Wed Jul 01, 2020 8:27 pm

Thanks, both sources have both a rendering and raw versions.

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

Re: Where is correct doc source?

Post by pythoncoder » Thu Jul 02, 2020 5:06 am

@hlovatt Your links throw 403 and 400 here. When making doc changes I've forked the source tree and proceeded as I described here. Doc changes and code changes are handled identically.
Peter Hinch

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

Re: Where is correct doc source?

Post by jimmo » Thu Jul 02, 2020 6:42 am

hlovatt wrote:
Wed Jul 01, 2020 12:41 am
Where is the correct location for the MicroPython docs source files, I can find two:
https://docs.micropython.org/en/latest/ ... s/library/
https://raw.githubusercontent.com/micro ... s/library/
The links don't work for me, but the background here:

Periodically the markdown (well, restructured text) is compiled with Sphinx to generate the HTML that is served by docs.micropython.org. The first URL is a snapshot of the markdown that was used to generate the site. (i.e. you're linking to the "latest" one, but equivalently there's the previous versions too.. e.g. 1.12, etc).

The second URL is a snapshot of the current master branch on github of those same markdown files. It turns out that GitHub knows how to render markdown, so it does its best (but really this site should be rendered by Sphinx).

hlovatt
Posts: 50
Joined: Thu Aug 15, 2019 3:52 am
Location: Sydney

Re: Where is correct doc source?

Post by hlovatt » Thu Jul 02, 2020 11:36 pm

Thanks, that clarifies.

Post Reply