tschm / pytest-alembic / 33150049929

100%

main: 100%

push

github

docs: set nitpicky so an unresolved cross-reference fails the docs gate.

`make docs` already builds under `-W`, but with `nitpicky` unset sphinx *silently drops*
an unresolved Python cross-reference and renders the text unlinked -- there was nothing
for `-W` to see. That is exactly how the stale intersphinx entry fixed in #227 got past
the docs gate: the references were pointing at SQLAlchemy 1.3 targets that no longer
existed, and the build stayed green while the rendered pages lost their links.

Setting `nitpicky = True` surfaced the whole standing backlog: 17 warnings, 10 unique.
All 17 are fixed here and no `nitpick_ignore` was needed.

- `intersphinx_mapping` gains alembic's inventory, which resolves the three
  `alembic.config.Config` references
- the fixture references in `runner.py` and `revision_data.py` are qualified: the fixtures
  live in `plugin.fixtures`, so a bare `:func:`alembic_runner`` never resolved outside that
  module's own autodoc context
- `dict` and `list` are `:class:`, not `:func:`
- `MigrationContext` is referenced as `pytest_alembic.runner.MigrationContext`, the path
  autodoc actually publishes, rather than `pytest_alembic.MigrationContext`
- `api.rst` documents `pytest_alembic.runner.runner` alongside `MigrationContext`; it is
  public, exported, and was already referenced from a docstring that could not resolve it

Verified in the built HTML rather than only by the absence of warnings: `api.html` links
`alembic.config.Config` to alembic's own page, `custom_data.html` links `dict` and `list`
into the python inventory, and `custom_tests.html` resolves `alembic_runner` to
`api.html#pytest_alembic.runner.MigrationContext`.

Second half of the issue: the supported platforms are now stated. The `cross-platform` job
added in #240 gates macOS and Windows, but nothing said so -- the classifiers named
interpreters only. `Operating System :: OS Independent` is added, and the README states the
Python, alembic and SQLAlchemy ranges... (continued)

196 of 196 branches covered (100.0%)

Branch coverage included in aggregate %.

885 of 885 relevant lines covered (100.0%)

7.95 hits per line