circuitpython

Commit Graph

Author	SHA1	Message	Date
Zenix27	e76c7466b6	docs: Change `\` to `` in argument lists. Latest versions of Sphinx (at least 3.1.0) do not need the `*` escaped and will render the `\` in the output if it is there, so remove it. Fixes issue #6209.	2020-08-21 12:24:13 +10:00
David Lechner	1e6d18c915	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 `	2020-06-05 21:42:17 +10:00
Jim Mussared	f2650be844	docs/library: Add docs for pyb.Flash class.	2019-12-04 23:18:17 +11:00

Author

SHA1

Message

Date

Zenix27

e76c7466b6

docs: Change `\*` to `*` in argument lists.

Latest versions of Sphinx (at least 3.1.0) do not need the `*` escaped and
will render the `\` in the output if it is there, so remove it.

Fixes issue #6209.

2020-08-21 12:24:13 +10:00

David Lechner

1e6d18c915

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 `

2020-06-05 21:42:17 +10:00

Jim Mussared

f2650be844

docs/library: Add docs for pyb.Flash class.

2019-12-04 23:18:17 +11:00

3 Commits