From aef3846c13d05ddf42e5d6a29042497765f4e871 Mon Sep 17 00:00:00 2001 From: Damien George <damien.p.george@gmail.com> Date: Thu, 25 Jun 2015 00:20:57 +0100 Subject: [PATCH] docs: Add "reference" directory for putting docs about the language. --- docs/esp8266_contents.rst | 3 ++- docs/pyboard_contents.rst | 1 + docs/reference/index.rst | 10 ++++++++++ docs/topindex.html | 4 ++++ docs/wipy_contents.rst | 1 + 5 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 docs/reference/index.rst diff --git a/docs/esp8266_contents.rst b/docs/esp8266_contents.rst index d1bd69c61..ec0a6f0e8 100644 --- a/docs/esp8266_contents.rst +++ b/docs/esp8266_contents.rst @@ -4,4 +4,5 @@ MicroPython documentation contents .. toctree:: library/index.rst - license.rst \ No newline at end of file + reference/index.rst + license.rst diff --git a/docs/pyboard_contents.rst b/docs/pyboard_contents.rst index abf7bd025..5ced479ef 100644 --- a/docs/pyboard_contents.rst +++ b/docs/pyboard_contents.rst @@ -7,6 +7,7 @@ MicroPython documentation contents pyboard/general.rst pyboard/tutorial/index.rst library/index.rst + reference/index.rst pyboard/hardware/index.rst license.rst diff --git a/docs/reference/index.rst b/docs/reference/index.rst new file mode 100644 index 000000000..784831986 --- /dev/null +++ b/docs/reference/index.rst @@ -0,0 +1,10 @@ +The MicroPython language +======================== + +MicroPython aims to implement the Python 3.4 standard, and most of +the features of MicroPython are identical to those described by the +documentation at +`docs.python.org <https://docs.python.org/3.4/reference/index.html>`_. + +Differences to standard Python as well as additional features of +MicroPython are described in the sections here. diff --git a/docs/topindex.html b/docs/topindex.html index 6bdafe856..d2cc06145 100644 --- a/docs/topindex.html +++ b/docs/topindex.html @@ -47,6 +47,10 @@ </p> </td> <td width="40%" style="padding-left:2em;"> + <p class="biglink"> + <a class="biglink" href="{{ pathto("reference/index") }}">Language Reference</a><br/> + <span class="linkdescr">information about MicroPython specific language features</span> + </p> {% if port == "pyboard" %} <p class="biglink"> <a class="biglink" href="{{ pathto(port + "/hardware/index") }}">The {{ port }} hardware</a><br/> diff --git a/docs/wipy_contents.rst b/docs/wipy_contents.rst index 8a7c0e06e..7f45a7aa8 100644 --- a/docs/wipy_contents.rst +++ b/docs/wipy_contents.rst @@ -6,4 +6,5 @@ MicroPython documentation contents wipy/quickref.rst wipy/general.rst library/index.rst + reference/index.rst license.rst -- GitLab