micropython/docs/templates/replace.inc

.. comment: This file is intended for global "replace" definitions.

.. |see_cpython| replace:: See CPython documentation:

.. |see_cpython_module| replace::

    *This module implements a subset of the corresponding* :term:`CPython` *module,
    as described below. For more information, refer to the original
    CPython documentation:*
docs/library: Add CPython docs xref to each pertinent module. Cross-reference text/link is implemented as RST substitution, so easy to consistently. 2017-07-02 12:37:31 +00:00			`.. comment: This file is intended for global "replace" definitions.`

docs/replace.inc: Add \|see_cpython\|, to xref individual symbols from CPython. The idea is to use it for each symbol in builtins.rst. 2017-07-02 12:43:12 +00:00			`.. \|see_cpython\| replace:: See CPython documentation:`

docs/library: Add CPython docs xref to each pertinent module. Cross-reference text/link is implemented as RST substitution, so easy to consistently. 2017-07-02 12:37:31 +00:00			`.. \|see_cpython_module\| replace::`

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-04 01:38:45 +00:00			This module implements a subset of the corresponding :term:`CPython` *module,
docs/library: Add CPython docs xref to each pertinent module. Cross-reference text/link is implemented as RST substitution, so easy to consistently. 2017-07-02 12:37:31 +00:00			`as described below. For more information, refer to the original`
			`CPython documentation:*`