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/library/esp32.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/library/esp32.rst')
| -rw-r--r-- | docs/library/esp32.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/library/esp32.rst b/docs/library/esp32.rst index f3be3692e..33b779a21 100644 --- a/docs/library/esp32.rst +++ b/docs/library/esp32.rst @@ -84,9 +84,9 @@ methods to enable over-the-air (OTA) updates. Returns a 6-tuple ``(type, subtype, addr, size, label, encrypted)``. .. method:: Partition.readblocks(block_num, buf) -.. method:: Partition.readblocks(block_num, buf, offset) + Partition.readblocks(block_num, buf, offset) .. method:: Partition.writeblocks(block_num, buf) -.. method:: Partition.writeblocks(block_num, buf, offset) + Partition.writeblocks(block_num, buf, offset) .. method:: Partition.ioctl(cmd, arg) These methods implement the simple and :ref:`extended |