Skip to content

Commit 3eece29

Browse files
committed
docs: Change "Micro Python" to "MicroPython" in all places in docs.
1 parent 601cfea commit 3eece29

17 files changed

+47
-47
lines changed

docs/conf.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env python3
22
# -*- coding: utf-8 -*-
33
#
4-
# Micro Python documentation build configuration file, created by
4+
# MicroPython documentation build configuration file, created by
55
# sphinx-quickstart on Sun Sep 21 11:42:03 2014.
66
#
77
# This file is execfile()d with the current directory set to its
@@ -50,7 +50,7 @@
5050
master_doc = 'index'
5151

5252
# General information about the project.
53-
project = 'Micro Python'
53+
project = 'MicroPython'
5454
copyright = '2014, Damien P. George'
5555

5656
# The version info for the project you're documenting, acts as replacement for
@@ -213,7 +213,7 @@
213213
# (source start file, target name, title,
214214
# author, documentclass [howto, manual, or own class]).
215215
latex_documents = [
216-
('index', 'MicroPython.tex', 'Micro Python Documentation',
216+
('index', 'MicroPython.tex', 'MicroPython Documentation',
217217
'Damien P. George', 'manual'),
218218
]
219219

@@ -243,7 +243,7 @@
243243
# One entry per manual page. List of tuples
244244
# (source start file, name, description, authors, manual section).
245245
man_pages = [
246-
('index', 'micropython', 'Micro Python Documentation',
246+
('index', 'micropython', 'MicroPython Documentation',
247247
['Damien P. George'], 1),
248248
]
249249

@@ -257,7 +257,7 @@
257257
# (source start file, target name, title, author,
258258
# dir menu entry, description, category)
259259
texinfo_documents = [
260-
('index', 'MicroPython', 'Micro Python Documentation',
260+
('index', 'MicroPython', 'MicroPython Documentation',
261261
'Damien P. George', 'MicroPython', 'One line description of project.',
262262
'Miscellaneous'),
263263
]

docs/contents.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Micro Python documentation contents
2-
===================================
1+
MicroPython documentation contents
2+
==================================
33

44
.. only:: port_pyboard
55

docs/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Micro Python documentation and references
2-
=========================================
1+
MicroPython documentation and references
2+
========================================
33

44
.. only:: port_pyboard
55

docs/library/index.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Micro Python libraries
2-
======================
1+
MicroPython libraries
2+
=====================
33

4-
Functionality specific to the Micro Python implementation is available in
4+
Functionality specific to the MicroPython implementation is available in
55
the following library.
66

77
.. toctree::
@@ -12,7 +12,7 @@ the following library.
1212
Python standard libraries
1313
-------------------------
1414

15-
The following standard Python libraries are built in to Micro Python.
15+
The following standard Python libraries are built in to MicroPython.
1616

1717
For additional libraries, please download them from the `micropython-lib repository
1818
<https://github.com/micropython/micropython-lib>`_.
@@ -33,7 +33,7 @@ Python micro-libraries
3333
----------------------
3434

3535
The following standard Python libraries have been "micro-ified" to fit in with
36-
the philosophy of Micro Python. They provide the core functionality of that
36+
the philosophy of MicroPython. They provide the core functionality of that
3737
module and are intended to be a drop-in replacement for the standard Python
3838
library.
3939

docs/library/micropython.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
:mod:`micropython` -- access and control Micro Python internals
2-
===============================================================
1+
:mod:`micropython` -- access and control MicroPython internals
2+
==============================================================
33

44
.. module:: micropython
5-
:synopsis: access and control Micro Python internals
5+
:synopsis: access and control MicroPython internals
66

77
Functions
88
---------

docs/library/pyb.UART.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To check if there is anything to be read, use::
3838

3939
uart.any() # returns True if any characters waiting
4040

41-
*Note:* The stream functions ``read``, ``write``, etc. are new in Micro Python v1.3.4.
41+
*Note:* The stream functions ``read``, ``write``, etc. are new in MicroPython v1.3.4.
4242
Earlier versions use ``uart.send`` and ``uart.recv``.
4343

4444
Constructors

docs/library/sys.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Constants
3939

4040
.. data:: platform
4141

42-
The platform that Micro Python is running on. This is "pyboard" on the
42+
The platform that MicroPython is running on. This is "pyboard" on the
4343
pyboard and provides a robust way of determining if a script is running
4444
on the pyboard or not.
4545

docs/license.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Micro Python license information
2-
================================
1+
MicroPython license information
2+
===============================
33

44
The MIT License (MIT)
55

docs/pyboard/tutorial/assembler.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
Inline assembler
22
================
33

4-
Here you will learn how to write inline assembler in Micro Python.
4+
Here you will learn how to write inline assembler in MicroPython.
55

66
**Note**: this is an advanced tutorial, intended for those who already
77
know a bit about microcontrollers and assembly language.
88

9-
Micro Python includes an inline assembler. It allows you to write
9+
MicroPython includes an inline assembler. It allows you to write
1010
assembly routines as a Python function, and you can call them as you would
1111
a normal Python function.
1212

@@ -23,7 +23,7 @@ Let's start with the simplest example::
2323
You can enter this in a script or at the REPL. This function takes no
2424
arguments and returns the number 42. ``r0`` is a register, and the value
2525
in this register when the function returns is the value that is returned.
26-
Micro Python always interprets the ``r0`` as an integer, and converts it to an
26+
MicroPython always interprets the ``r0`` as an integer, and converts it to an
2727
integer object for the caller.
2828

2929
If you run ``print(fun())`` you will see it print out 42.

docs/pyboard/tutorial/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _tutorial-index:
22

3-
Micro Python tutorial
4-
=====================
3+
MicroPython tutorial
4+
====================
55

66
This tutorial is intended to get you started with your pyboard.
77
All you need is a pyboard and a micro-USB cable to connect it to

docs/pyboard/tutorial/intro.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ As long as you take care of the hardware, you should be okay. It's almost
2424
impossible to break the software on the pyboard, so feel free to play around
2525
with writing code as much as you like. If the filesystem gets corrupt, see
2626
below on how to reset it. In the worst case you might need to reflash the
27-
Micro Python software, but that can be done over USB.
27+
MicroPython software, but that can be done over USB.
2828

2929
Layout of the pyboard
3030
---------------------

docs/pyboard/tutorial/lcd_skin.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ For circuit schematics and datasheets for the components on the skin see :ref:`h
2323
Using the LCD
2424
-------------
2525

26-
To get started using the LCD, try the following at the Micro Python prompt.
26+
To get started using the LCD, try the following at the MicroPython prompt.
2727
Make sure the LCD skin is attached to the pyboard as pictured at the top of this page. ::
2828

2929
>>> import pyb

docs/pyboard/tutorial/leds.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Next we will set up an infinite loop that cycles through each of the LEDs turnin
4444

4545
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.
4646

47-
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::
47+
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::
4848

4949
leds = [pyb.LED(i) for i in range(1,5)]
5050
for l in leds:

docs/pyboard/tutorial/repl.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
Getting a Micro Python REPL prompt
2-
==================================
1+
Getting a MicroPython REPL prompt
2+
=================================
33

44
REPL stands for Read Evaluate Print Loop, and is the name given to the
5-
interactive Micro Python prompt that you can access on the pyboard. Using
5+
interactive MicroPython prompt that you can access on the pyboard. Using
66
the REPL is by far the easiest way to test out your code and run commands.
77
You can use the REPL in addition to writing scripts in ``main.py``.
88

@@ -59,11 +59,11 @@ or use sudo).
5959
Using the REPL prompt
6060
---------------------
6161

62-
Now let's try running some Micro Python code directly on the pyboard.
62+
Now let's try running some MicroPython code directly on the pyboard.
6363

6464
With your serial program open (PuTTY, screen, picocom, etc) you may see a blank
6565
screen with a flashing cursor. Press Enter and you should be presented with a
66-
Micro Python prompt, i.e. ``>>>``. Let's make sure it is working with the obligatory test::
66+
MicroPython prompt, i.e. ``>>>``. Let's make sure it is working with the obligatory test::
6767

6868
>>> print("hello pyboard!")
6969
hello pyboard!
@@ -93,7 +93,7 @@ Resetting the board
9393
-------------------
9494

9595
If something goes wrong, you can reset the board in two ways. The first is to press CTRL-D
96-
at the Micro Python prompt, which performs a soft reset. You will see a message something like ::
96+
at the MicroPython prompt, which performs a soft reset. You will see a message something like ::
9797

9898
>>>
9999
PYB: sync filesystems

docs/pyboard/tutorial/script.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,5 +101,5 @@ on the right edge.
101101
When you press RST the green LED will flash quickly, and then the blue
102102
LED should turn on and stay on.
103103

104-
Congratulations! You have written and run your very first Micro Python
104+
Congratulations! You have written and run your very first MicroPython
105105
program!

docs/static/customstyle.css

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/* custom CSS for Micro Python docs
1+
/* custom CSS for MicroPython docs
22
*/
33

44
.admonition-difference-to-cpython {

docs/topindex.html

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{% extends "defindex.html" %}
22
{% block body %}
33

4-
<h1>Micro Python documentation</h1>
4+
<h1>MicroPython documentation</h1>
55

66
<p>
7-
{{ _('Welcome! This is the documentation for Micro Python') }}
7+
{{ _('Welcome! This is the documentation for MicroPython') }}
88
v{{ release|e }}{% if last_updated %}, {{ _('last updated') }} {{ last_updated|e }}{% endif %}.
99
</p>
1010

@@ -21,7 +21,7 @@ <h1>Micro Python documentation</h1>
2121
{% endfor %}.
2222
</p-->
2323

24-
<p><strong>Documentation for Micro Python and the pyboard:</strong></p>
24+
<p><strong>Documentation for MicroPython and the pyboard:</strong></p>
2525

2626
<table class="contentstable"><tr>
2727
<td width="40%" style="padding-left:2em;">
@@ -41,7 +41,7 @@ <h1>Micro Python documentation</h1>
4141
{% endif %}
4242
<p class="biglink">
4343
<a class="biglink" href="{{ pathto("library/index") }}">Library Reference</a><br/>
44-
<span class="linkdescr">Micro Python libraries, including the <a href="{{ pathto("library/pyb") }}">pyb module</a></span>
44+
<span class="linkdescr">MicroPython libraries, including the <a href="{{ pathto("library/pyb") }}">pyb module</a></span>
4545
</p>
4646
</td>
4747
<td width="40%" style="padding-left:2em;">
@@ -57,7 +57,7 @@ <h1>Micro Python documentation</h1>
5757
{% endif %}
5858
<p class="biglink">
5959
<a class="biglink" href="{{ pathto("license") }}">License</a><br/>
60-
<span class="linkdescr">Micro Python license information</span>
60+
<span class="linkdescr">MicroPython license information</span>
6161
</p>
6262
</td>
6363
</tr></table>
@@ -87,17 +87,17 @@ <h1>Micro Python documentation</h1>
8787
<table class="contentstable"><tr>
8888
<td width="40%" style="padding-left:2em;">
8989
<p class="biglink">
90-
<a class="biglink" href="http://micropython.org">Micro Python homepage</a><br/>
91-
<span class="linkdescr">the official Micro Python site</span>
90+
<a class="biglink" href="http://micropython.org">MicroPython homepage</a><br/>
91+
<span class="linkdescr">the official MicroPython site</span>
9292
</p>
9393
<p class="biglink">
94-
<a class="biglink" href="http://forum.micropython.org">Micro Python forum</a><br/>
95-
<span class="linkdescr">community discussion for all things related to Micro Python</span>
94+
<a class="biglink" href="http://forum.micropython.org">MicroPython forum</a><br/>
95+
<span class="linkdescr">community discussion for all things related to MicroPython</span>
9696
</p>
9797
</td>
9898
<td width="40%" style="padding-left:2em;">
9999
<p class="biglink">
100-
<a class="biglink" href="https://github.com/micropython">Micro Python on GitHub</a><br/>
100+
<a class="biglink" href="https://github.com/micropython">MicroPython on GitHub</a><br/>
101101
<span class="linkdescr">contribute to the source code on GitHub</span>
102102
</p>
103103
</td>

0 commit comments

Comments
 (0)