Lint docstrings examples

Use the new utility functions to lint the examples in the code
docstrings.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

MANIFEST.in

@@ -6,6 +6,7 @@ exclude CODEOWNERS
 exclude CONTRIBUTING.md
 exclude mkdocs.yml
 exclude noxfile.py
+exclude src/conftest.py
 recursive-exclude .github *
 recursive-exclude cookiecutter *
 recursive-exclude docs *

pyproject.toml

@@ -83,13 +83,15 @@ dev-mypy = [
 ]
 dev-noxfile = ["nox == 2023.4.22"]
 dev-pylint = [
-  "pylint == 2.17.3",
+  # dev-pytest already defines a dependency to pylint because of the examples
   # For checking the noxfile, docs/ script, and tests
   "frequenz-repo-config[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 7.3.1",
+  "pytest == 7.4.0",
+  "pylint == 2.17.3",      # We need this to check for the examples
   "cookiecutter == 2.1.1", # For checking the cookiecutter scripts
+  "sybil == 5.0.3",        # Should be consistent with the extra-lint-examples dependency
 ]
 dev = [
   "frequenz-repo-config[dev-mkdocs,dev-docstrings,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
@@ -133,7 +135,7 @@ module = ["cookiecutter", "cookiecutter.*", "sybil", "sybil.*"]
 ignore_missing_imports = true
 
 [tool.pytest.ini_options]
-testpaths = ["tests"]
+testpaths = ["src", "tests"]
 markers = [
   "integration: integration tests (deselect with '-m \"not integration\"')",
 ]

src/conftest.py

@@ -0,0 +1,14 @@
+# License: MIT
+# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+
+"""Validate docstring code examples.
+
+Code examples are often wrapped in triple backticks (```) within docstrings.
+This plugin extracts these code examples and validates them using pylint.
+"""
+
+from sybil import Sybil
+
+from frequenz.repo.config.pytest import examples
+
+pytest_collect_file = Sybil(**examples.get_sybil_arguments()).pytest()