Tatsh / archiver-stats / 24546152837

100%

push

github

docs: document the public API and usage

Add Sphinx API reference for archiver_stats, archiver_stats.stats, and
archiver_stats.display, plus an installation section and a runnable usage
example in both docs/index.rst and README.md.

Register a Rich intersphinx mapping so cross-references to rich.live.Live
and friends resolve. Update two docstring cross-references in stats.py to
point at the canonical submodule locations now that those are where the
classes are documented.

Signed-off-by: Andrew Udvare <audvare@gmail.com>

20 of 20 branches covered (100.0%)

Branch coverage included in aggregate %.

152 of 152 relevant lines covered (100.0%)

5.0 hits per line