MicroPython Forum (Archive)

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?

Seems like the first one is the official one.

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.

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

@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.

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).

Thanks, that clarifies.