fix(docs): rename mkdocstrings 'import' option to 'inventories'

[Bojun-Vvibe]

Closes #272

Repo

openzim/python-scraperlib

Issue

#272

Root cause

The Read the Docs build runs hatch run docs:build which invokes mkdocs build. The mkdocstrings-python handler (pinned at mkdocstrings[python]==0.30.1) renamed its configuration key import to inventories; the old name now raises TypeError: PythonConfig.__init__() got an unexpected keyword argument 'import', causing every RTD build (including 5.3.0 publication) to fail.

Fix

Renamed the import: key under plugins.mkdocstrings.handlers.python in mkdocs.yml to inventories:, keeping the same value (https://docs.python.org/3/objects.inv).

Regression test

None added — the bug is purely in the static mkdocs.yml configuration; the project has no test suite for documentation config. Validation is via mkdocs build succeeding on Read the Docs (or locally inside the docs hatch env).

Risk

trivial

Verification

skipped: full validation requires installing the docs hatch env (mkdocs + mkdocs-material + mkdocstrings + mkdocs-gen-files + literate-nav, etc.) which is heavy. Confirmed YAML still parses correctly via python3 -c "import yaml; yaml.safe_load(open('mkdocs.yml'))". The error message in the RTD build log (unexpected keyword argument 'import') and the upstream mkdocstrings-python rename of import -> inventories make the fix unambiguous.

[benoit74]

@Bojun-Vvibe thank you, I'm adding a CI job to check we can build the doc in the CI and I will merge

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.96%. Comparing base (d6bd4b3) to head (f303f4d).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #298   +/-   ##
=======================================
  Coverage   99.96%   99.96%           
=======================================
  Files          41       41           
  Lines        2542     2542           
  Branches      362      362           
=======================================
  Hits         2541     2541           
  Partials        1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.