Where is the correct location for the MicroPython docs source files, I can find two:
Which is the correct source?
Where is correct doc source?
Re: Where is correct doc source?
Seems like the first one is the official one.
Re: Where is correct doc source?
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.
The first one, should be a "rendering" of whatever is found in the github repository.
Re: Where is correct doc source?
Thanks, both sources have both a rendering and raw versions.
- pythoncoder
- Posts: 5956
- Joined: Fri Jul 18, 2014 8:01 am
- Location: UK
- Contact:
Re: Where is correct doc source?
@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
Index to my micropython libraries.
Index to my micropython libraries.
Re: Where is correct doc source?
The links don't work for me, but the background here:hlovatt wrote: ↑Wed Jul 01, 2020 12:41 amWhere 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/
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).
Re: Where is correct doc source?
Thanks, that clarifies.