gdtest_examples_rst_repro — Synthetic Package Details

#144 gdtest_examples_rst_repro OK CONFIG

RST markup inside a numpy Examples section (finding #1 repro)

View Site → Build Log 🧪 Test Coverage

Build Mode

● Has great-docs.yml

This package ships a pre-supplied config. The great-docs init step is skipped and great-docs build uses the spec-defined configuration directly. Tests specific config options and their rendered output.

Dimensions

L18

L18Examples sectiondocstring

Source Files

📁 gdtest_examples_rst_repro/

📄 __init__.py

"""Package reproducing RST-in-Examples rendering."""

__version__ = "0.1.0"
__all__ = ["compute"]


def compute(n: int) -> int:
    """
    Compute something, see :func:`compute` and :math:`n^2`.

    This BODY paragraph contains a role :func:`compute` and inline
    math :math:`x_i` and an RST literal ``value``. These should be
    converted (role -> link/code, math -> MathJax, literal -> code).

    Examples
    --------
    >>> compute(2)
    4

    The PROSE below references :func:`compute` and inline math
    :math:`n^2` and an RST literal ``value`` — the exact same
    markup as the body above:

    >>> compute(3)
    9
    """
    return n * n

📄 README.md

# gdtest-examples-rst-repro

Repro package for RST markup inside a numpy Examples section.

📄 great-docs.yml

parser: numpy