aboutsummaryrefslogtreecommitdiff
path: root/docs/library/micropython.rst
diff options
context:
space:
mode:
authorDavid Lechner <david@pybricks.com>2020-06-03 20:38:45 -0500
committerDamien George <damien.p.george@gmail.com>2020-06-05 21:42:17 +1000
commit1e6d18c915ccea0b6a19ffec9710d33dd7e5f866 (patch)
tree8491c9aa42398bb2849cea690108e2af60d3cf37 /docs/library/micropython.rst
parenteeca2c3cbe84975ffabd7fda932b2f5674e8b0fc (diff)
docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build.
This enables warnings as errors and fixes all current errors, namely: - reference to terms in the glossary must now be explicit (:term:) - method overloads must not be declared as a separate method or must use :noindex: - 2 cases where `` should have been used instead of `
Diffstat (limited to 'docs/library/micropython.rst')
-rw-r--r--docs/library/micropython.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/library/micropython.rst b/docs/library/micropython.rst
index ded52deb0..7106a1a2f 100644
--- a/docs/library/micropython.rst
+++ b/docs/library/micropython.rst
@@ -100,7 +100,7 @@ Functions
unlocked.
Note: `heap_locked()` is not enabled on most ports by default,
- requires `MICROPY_PY_MICROPYTHON_HEAP_LOCKED`.
+ requires ``MICROPY_PY_MICROPYTHON_HEAP_LOCKED``.
.. function:: kbd_intr(chr)