API Reference Documentation

[shivashanmugam]

API Reference Documentation

There are four __init__.py files have added

src/microbots/environment/local_docker/image_builder/__init__.py
src/microbots/environment/__init__.py
src/microbots/tools/__init__.py
src/microbots/utils/__init__.py

Why these __init__.py file additions are required

1.Zensical uses mkdocstrings plugin to render API docs
2.mkdocstrings uses griffe to discover and parse Python source code
3.Griffe uses Python's standard package resolution to find modules

When your stub file says ::: microbots.MicroBot, griffe needs to resolve microbots.MicroBot to a file path. It does this by:
1.Looking in the configured paths: [src] directory
2.Finding microbots — and checking: is this a Python package?
3.A directory is a Python package only if it contains init.py
4.If tools has no init.py, griffe doesn't recognize it as a package, so microbots.tools.tool can't be resolved to tool.py

In short: Griffe follows Python's own package rules. Without init.py, a directory is just a folder, not a Python package — so dotted module paths like microbots.tools.tool have no meaning.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.33%. Comparing base (a080fd3) to head (d75c462).

Additional details and impacted files

@@             Coverage Diff             @@
##             main     #136       +/-   ##
===========================================
- Coverage   97.15%   64.33%   -32.82%     
===========================================
  Files          30       33        +3     
  Lines        1546     2333      +787     
===========================================
- Hits         1502     1501        -1     
- Misses         44      832      +788     

Flag	Coverage Δ
integration	34.33% <ø> (-17.22%)	⬇️
ollama_local	32.10% <ø> (-16.09%)	⬇️
slow-browser	26.57% <ø> (-13.53%)	⬇️
slow-other	38.79% <ø> (-19.04%)	⬇️
unit	58.46% <ø> (-29.77%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 4 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.