diff options
| author | nanjekyejoannah <joannah.nanjekye@ibm.com> | 2020-10-12 17:25:05 -0300 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2021-01-27 16:59:58 +1100 |
| commit | 4eaebc1988699db6ebfd35fbe56a3e8d4cd0b373 (patch) | |
| tree | ae2efb6e48fc19241b94c2b22f800a7883fff608 /docs/develop/index.rst | |
| parent | 203e1d2a65273db3f6ff063ba1124a89c3482c0f (diff) | |
docs/develop: Add MicroPython Internals chapter.
This commit adds many new sections to the existing "Developing and building
MicroPython" chapter to make it all about the internals of MicroPython.
This work was done as part of Google's Season of Docs 2020.
Diffstat (limited to 'docs/develop/index.rst')
| -rw-r--r-- | docs/develop/index.rst | 31 |
1 files changed, 22 insertions, 9 deletions
diff --git a/docs/develop/index.rst b/docs/develop/index.rst index f1fd0692e..7a6a6be67 100644 --- a/docs/develop/index.rst +++ b/docs/develop/index.rst @@ -1,14 +1,27 @@ -Developing and building MicroPython -=================================== +MicroPython Internals +===================== -This chapter describes some options for extending MicroPython in C. Note -that it doesn't aim to be a complete guide for developing with MicroPython. -See the `getting started guide -<https://github.com/micropython/micropython/wiki/Getting-Started>`_ for further information. +This chapter covers a tour of MicroPython from the perspective of a developer, contributing +to MicroPython. It acts as a comprehensive resource on the implementation details of MicroPython +for both novice and expert contributors. + +Development around MicroPython usually involves modifying the core runtime, porting or +maintaining a new library. This guide describes at great depth, the implementation +details of MicroPython including a getting started guide, compiler internals, porting +MicroPython to a new platform and implementing a core MicroPython library. .. toctree:: - :maxdepth: 1 + :maxdepth: 3 - cmodules.rst + gettingstarted.rst + writingtests.rst + compiler.rst + memorymgt.rst + library.rst + optimizations.rst qstr.rst - natmod.rst + maps.rst + publiccapi.rst + extendingmicropython.rst + porting.rst +
\ No newline at end of file |