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 `
This commit is contained in:
David Lechner
2020-06-03 20:38:45 -05:00
committed by Damien George
parent eeca2c3cbe
commit 1e6d18c915
17 changed files with 54 additions and 50 deletions

View File

@@ -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