diff options
| author | David Lechner <david@pybricks.com> | 2020-06-03 20:38:45 -0500 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2020-06-05 21:42:17 +1000 |
| commit | 1e6d18c915ccea0b6a19ffec9710d33dd7e5f866 (patch) | |
| tree | 8491c9aa42398bb2849cea690108e2af60d3cf37 /docs/reference/pyboard.py.rst | |
| parent | eeca2c3cbe84975ffabd7fda932b2f5674e8b0fc (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/reference/pyboard.py.rst')
| -rw-r--r-- | docs/reference/pyboard.py.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/reference/pyboard.py.rst b/docs/reference/pyboard.py.rst index d404c738f..30230eebc 100644 --- a/docs/reference/pyboard.py.rst +++ b/docs/reference/pyboard.py.rst @@ -68,7 +68,7 @@ example:: $ pyboard.py -c 'print(1+1)' Similarly, the ``PYBOARD_BAUDRATE`` environment variable can be used -to set the default for the `--baudrate` option. +to set the default for the ``--baudrate`` option. Running a script on the device ------------------------------ |