diff --git a/docs/conf.py b/docs/conf.py index a3de50d81a..5c5f28a7b8 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,7 +1,7 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- # -# Micro Python documentation build configuration file, created by +# MicroPython documentation build configuration file, created by # sphinx-quickstart on Sun Sep 21 11:42:03 2014. # # This file is execfile()d with the current directory set to its @@ -50,7 +50,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = 'Micro Python' +project = 'MicroPython' copyright = '2014, Damien P. George' # The version info for the project you're documenting, acts as replacement for @@ -213,7 +213,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'MicroPython.tex', 'Micro Python Documentation', + ('index', 'MicroPython.tex', 'MicroPython Documentation', 'Damien P. George', 'manual'), ] @@ -243,7 +243,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'micropython', 'Micro Python Documentation', + ('index', 'micropython', 'MicroPython Documentation', ['Damien P. George'], 1), ] @@ -257,7 +257,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'MicroPython', 'Micro Python Documentation', + ('index', 'MicroPython', 'MicroPython Documentation', 'Damien P. George', 'MicroPython', 'One line description of project.', 'Miscellaneous'), ] diff --git a/docs/contents.rst b/docs/contents.rst index b35e80d85f..15b92f6a04 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -1,5 +1,5 @@ -Micro Python documentation contents -=================================== +MicroPython documentation contents +================================== .. only:: port_pyboard diff --git a/docs/index.rst b/docs/index.rst index e86ff857b7..3c074e55d1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ -Micro Python documentation and references -========================================= +MicroPython documentation and references +======================================== .. only:: port_pyboard diff --git a/docs/library/index.rst b/docs/library/index.rst index 9b77271814..245a345f36 100644 --- a/docs/library/index.rst +++ b/docs/library/index.rst @@ -1,7 +1,7 @@ -Micro Python libraries -====================== +MicroPython libraries +===================== -Functionality specific to the Micro Python implementation is available in +Functionality specific to the MicroPython implementation is available in the following library. .. toctree:: @@ -12,7 +12,7 @@ the following library. Python standard libraries ------------------------- -The following standard Python libraries are built in to Micro Python. +The following standard Python libraries are built in to MicroPython. For additional libraries, please download them from the `micropython-lib repository `_. @@ -33,7 +33,7 @@ Python micro-libraries ---------------------- The following standard Python libraries have been "micro-ified" to fit in with -the philosophy of Micro Python. They provide the core functionality of that +the philosophy of MicroPython. They provide the core functionality of that module and are intended to be a drop-in replacement for the standard Python library. diff --git a/docs/library/micropython.rst b/docs/library/micropython.rst index 7564f29ae2..83ccb2900f 100644 --- a/docs/library/micropython.rst +++ b/docs/library/micropython.rst @@ -1,8 +1,8 @@ -:mod:`micropython` -- access and control Micro Python internals -=============================================================== +:mod:`micropython` -- access and control MicroPython internals +============================================================== .. module:: micropython - :synopsis: access and control Micro Python internals + :synopsis: access and control MicroPython internals Functions --------- diff --git a/docs/library/pyb.UART.rst b/docs/library/pyb.UART.rst index 5e0f15df07..75d1fbe9b4 100644 --- a/docs/library/pyb.UART.rst +++ b/docs/library/pyb.UART.rst @@ -38,7 +38,7 @@ To check if there is anything to be read, use:: uart.any() # returns True if any characters waiting -*Note:* The stream functions ``read``, ``write``, etc. are new in Micro Python v1.3.4. +*Note:* The stream functions ``read``, ``write``, etc. are new in MicroPython v1.3.4. Earlier versions use ``uart.send`` and ``uart.recv``. Constructors diff --git a/docs/library/sys.rst b/docs/library/sys.rst index 5f5f18b463..b3e52c40c4 100644 --- a/docs/library/sys.rst +++ b/docs/library/sys.rst @@ -39,7 +39,7 @@ Constants .. data:: platform - The platform that Micro Python is running on. This is "pyboard" on the + The platform that MicroPython is running on. This is "pyboard" on the pyboard and provides a robust way of determining if a script is running on the pyboard or not. diff --git a/docs/license.rst b/docs/license.rst index 4c0b10d3ad..bbc5016ed7 100644 --- a/docs/license.rst +++ b/docs/license.rst @@ -1,5 +1,5 @@ -Micro Python license information -================================ +MicroPython license information +=============================== The MIT License (MIT) diff --git a/docs/pyboard/tutorial/assembler.rst b/docs/pyboard/tutorial/assembler.rst index 777600fc86..0e265eef10 100644 --- a/docs/pyboard/tutorial/assembler.rst +++ b/docs/pyboard/tutorial/assembler.rst @@ -1,12 +1,12 @@ Inline assembler ================ -Here you will learn how to write inline assembler in Micro Python. +Here you will learn how to write inline assembler in MicroPython. **Note**: this is an advanced tutorial, intended for those who already know a bit about microcontrollers and assembly language. -Micro Python includes an inline assembler. It allows you to write +MicroPython includes an inline assembler. It allows you to write assembly routines as a Python function, and you can call them as you would a normal Python function. @@ -23,7 +23,7 @@ Let's start with the simplest example:: You can enter this in a script or at the REPL. This function takes no arguments and returns the number 42. ``r0`` is a register, and the value in this register when the function returns is the value that is returned. -Micro Python always interprets the ``r0`` as an integer, and converts it to an +MicroPython always interprets the ``r0`` as an integer, and converts it to an integer object for the caller. If you run ``print(fun())`` you will see it print out 42. diff --git a/docs/pyboard/tutorial/index.rst b/docs/pyboard/tutorial/index.rst index c134d0deb7..ae40f47b80 100644 --- a/docs/pyboard/tutorial/index.rst +++ b/docs/pyboard/tutorial/index.rst @@ -1,7 +1,7 @@ .. _tutorial-index: -Micro Python tutorial -===================== +MicroPython tutorial +==================== This tutorial is intended to get you started with your pyboard. All you need is a pyboard and a micro-USB cable to connect it to diff --git a/docs/pyboard/tutorial/intro.rst b/docs/pyboard/tutorial/intro.rst index fea124459b..78343db59a 100644 --- a/docs/pyboard/tutorial/intro.rst +++ b/docs/pyboard/tutorial/intro.rst @@ -24,7 +24,7 @@ As long as you take care of the hardware, you should be okay. It's almost impossible to break the software on the pyboard, so feel free to play around with writing code as much as you like. If the filesystem gets corrupt, see below on how to reset it. In the worst case you might need to reflash the -Micro Python software, but that can be done over USB. +MicroPython software, but that can be done over USB. Layout of the pyboard --------------------- diff --git a/docs/pyboard/tutorial/lcd_skin.rst b/docs/pyboard/tutorial/lcd_skin.rst index 8ee31d9603..4f3b30a4a0 100644 --- a/docs/pyboard/tutorial/lcd_skin.rst +++ b/docs/pyboard/tutorial/lcd_skin.rst @@ -23,7 +23,7 @@ For circuit schematics and datasheets for the components on the skin see :ref:`h Using the LCD ------------- -To get started using the LCD, try the following at the Micro Python prompt. +To get started using the LCD, try the following at the MicroPython prompt. Make sure the LCD skin is attached to the pyboard as pictured at the top of this page. :: >>> import pyb diff --git a/docs/pyboard/tutorial/leds.rst b/docs/pyboard/tutorial/leds.rst index 2105580e8d..763eedf01c 100644 --- a/docs/pyboard/tutorial/leds.rst +++ b/docs/pyboard/tutorial/leds.rst @@ -44,7 +44,7 @@ Next we will set up an infinite loop that cycles through each of the LEDs turnin Here, n keeps track of the current LED and every time the loop is executed we cycle to the next n (the % sign is a modulus operator that keeps n between 0 and 3.) Then we access the nth LED and toggle it. If you run this you should see each of the LEDs turning on then all turning off again in sequence. -One problem you might find is that if you stop the script and then start it again that the LEDs are stuck on from the previous run, ruining our carefully choreographed disco. We can fix this by turning all the LEDs off when we initialise the script and then using a try/finally block. When you press CTRL-C, Micro Python generates a VCPInterrupt exception. Exceptions normally mean something has gone wrong and you can use a try: command to "catch" an exception. In this case it is just the user interrupting the script, so we don't need to catch the error but just tell Micro Python what to do when we exit. The finally block does this, and we use it to make sure all the LEDs are off. The full code is:: +One problem you might find is that if you stop the script and then start it again that the LEDs are stuck on from the previous run, ruining our carefully choreographed disco. We can fix this by turning all the LEDs off when we initialise the script and then using a try/finally block. When you press CTRL-C, MicroPython generates a VCPInterrupt exception. Exceptions normally mean something has gone wrong and you can use a try: command to "catch" an exception. In this case it is just the user interrupting the script, so we don't need to catch the error but just tell MicroPython what to do when we exit. The finally block does this, and we use it to make sure all the LEDs are off. The full code is:: leds = [pyb.LED(i) for i in range(1,5)] for l in leds: diff --git a/docs/pyboard/tutorial/repl.rst b/docs/pyboard/tutorial/repl.rst index 303f035f8d..646ecbc237 100644 --- a/docs/pyboard/tutorial/repl.rst +++ b/docs/pyboard/tutorial/repl.rst @@ -1,8 +1,8 @@ -Getting a Micro Python REPL prompt -================================== +Getting a MicroPython REPL prompt +================================= REPL stands for Read Evaluate Print Loop, and is the name given to the -interactive Micro Python prompt that you can access on the pyboard. Using +interactive MicroPython prompt that you can access on the pyboard. Using the REPL is by far the easiest way to test out your code and run commands. You can use the REPL in addition to writing scripts in ``main.py``. @@ -59,11 +59,11 @@ or use sudo). Using the REPL prompt --------------------- -Now let's try running some Micro Python code directly on the pyboard. +Now let's try running some MicroPython code directly on the pyboard. With your serial program open (PuTTY, screen, picocom, etc) you may see a blank screen with a flashing cursor. Press Enter and you should be presented with a -Micro Python prompt, i.e. ``>>>``. Let's make sure it is working with the obligatory test:: +MicroPython prompt, i.e. ``>>>``. Let's make sure it is working with the obligatory test:: >>> print("hello pyboard!") hello pyboard! @@ -93,7 +93,7 @@ Resetting the board ------------------- If something goes wrong, you can reset the board in two ways. The first is to press CTRL-D -at the Micro Python prompt, which performs a soft reset. You will see a message something like :: +at the MicroPython prompt, which performs a soft reset. You will see a message something like :: >>> PYB: sync filesystems diff --git a/docs/pyboard/tutorial/script.rst b/docs/pyboard/tutorial/script.rst index 011484722c..75dd324e3c 100644 --- a/docs/pyboard/tutorial/script.rst +++ b/docs/pyboard/tutorial/script.rst @@ -101,5 +101,5 @@ on the right edge. When you press RST the green LED will flash quickly, and then the blue LED should turn on and stay on. -Congratulations! You have written and run your very first Micro Python +Congratulations! You have written and run your very first MicroPython program! diff --git a/docs/static/customstyle.css b/docs/static/customstyle.css index e91328b1e3..74eff4e051 100644 --- a/docs/static/customstyle.css +++ b/docs/static/customstyle.css @@ -1,4 +1,4 @@ -/* custom CSS for Micro Python docs +/* custom CSS for MicroPython docs */ .admonition-difference-to-cpython { diff --git a/docs/topindex.html b/docs/topindex.html index a810f61c4f..d28132df18 100644 --- a/docs/topindex.html +++ b/docs/topindex.html @@ -1,10 +1,10 @@ {% extends "defindex.html" %} {% block body %} -

Micro Python documentation

+

MicroPython documentation

- {{ _('Welcome! This is the documentation for Micro Python') }} + {{ _('Welcome! This is the documentation for MicroPython') }} v{{ release|e }}{% if last_updated %}, {{ _('last updated') }} {{ last_updated|e }}{% endif %}.

@@ -21,7 +21,7 @@ {% endfor %}. -

Documentation for Micro Python and the pyboard:

+

Documentation for MicroPython and the pyboard:

@@ -41,7 +41,7 @@ {% endif %}

Library Reference
- Micro Python libraries, including the pyb module + MicroPython libraries, including the pyb module

@@ -57,7 +57,7 @@ {% endif %}

License
- Micro Python license information + MicroPython license information

@@ -87,17 +87,17 @@

- Micro Python homepage
- the official Micro Python site + MicroPython homepage
+ the official MicroPython site

- Micro Python forum
- community discussion for all things related to Micro Python + MicroPython forum
+ community discussion for all things related to MicroPython

- Micro Python on GitHub
+ MicroPython on GitHub
contribute to the source code on GitHub