sphinx_reports.Adapter.DocStrCoverage

A Sphinx extension providing documentation coverage details embedded in documentation pages.

Exceptions

• DocStrCoverageError: Extension error.

Classes

• Analyzer: Undocumented.

---

Exceptions

exception sphinx_reports.Adapter.DocStrCoverage.DocStrCoverageError(message, orig_exc=None, modname=None)

Inheritance

Parameters:

• message (str)

• orig_exc (Exception | None)

• modname (str | None)

Return type:

None

---

Classes

class sphinx_reports.Adapter.DocStrCoverage.Analyzer(packageName, directory)

Inheritance

Parameters:

• packageName (str)

• directory (Path)

__init__(packageName, directory)

Parameters:

• packageName (str)

• directory (Path)

Return type:

None