docs: re-arange api reference

[smlloyd]

---

📚 Documentation preview 📚: https://aimbat--219.org.readthedocs.build/en/219/

[codecov]

Codecov Report

❌ Patch coverage is 21.42857% with 11 lines in your changes missing coverage. Please review.
✅ Project coverage is 92.96%. Comparing base (458bd3f) to head (77228b8).
⚠️ Report is 2 commits behind head on master.
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
src/aimbat/_config.py	8.33%	11 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #219      +/-   ##
==========================================
- Coverage   93.51%   92.96%   -0.55%     
==========================================
  Files          45       45              
  Lines        1849     1862      +13     
==========================================
+ Hits         1729     1731       +2     
- Misses        120      131      +11     

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

[Copilot]

Pull request overview

Reorganises the documentation navigation to provide a more granular API reference and adds a “Defaults” usage page backed by a generated settings table.

Changes:

• Reworked docs navigation to list individual aimbat.* API reference pages.
• Added docs/usage/defaults.md and build steps (Makefile/CI/RTD) to generate an included defaults settings table.
• Minor internal clean-ups (parameter typo fix in add_data_to_project, formatting tweaks, and explicit __all__ export).

Reviewed changes

Copilot reviewed 18 out of 19 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
zensical.toml	Updates site nav (adds Defaults page; replaces API index with per-module API pages).
src/aimbat/core/_project.py	Formatting-only change for trigger DDL execution calls.
src/aimbat/core/_data.py	Fixes parameter name typo (datas_sources → data_sources).
src/aimbat/_config.py	Adds Settings docstring + markdown defaults-table generator and updates __main__ output.
src/aimbat/__init__.py	Adds __all__ for explicit exports.
docs/usage/defaults.md	New Defaults page that includes a generated markdown table snippet.
docs/api/aimbat.md	Adjusts mkdocstrings options (disables submodule listing on root).
docs/api/aimbat/app.md	New mkdocstrings page for aimbat.app.
docs/api/aimbat/aimbat_types.md	New mkdocstrings page for aimbat.aimbat_types.
docs/api/aimbat/cli.md	New mkdocstrings page for aimbat.cli.
docs/api/aimbat/core.md	New mkdocstrings page for aimbat.core.
docs/api/aimbat/db.md	New mkdocstrings page for aimbat.db.
docs/api/aimbat/io.md	New mkdocstrings page for aimbat.io.
docs/api/aimbat/logger.md	New mkdocstrings page for aimbat.logger.
docs/api/aimbat/models.md	New mkdocstrings page for aimbat.models.
docs/api/aimbat/utils.md	New mkdocstrings page for aimbat.utils.
Makefile	Ensures defaults table is generated before docs build/serve.
.readthedocs.yml	Generates defaults table during RTD build.
.github/workflows/docs.yml	Generates defaults table during GitHub Pages docs workflow.
.gitignore	Ignores generated docs/usage/defaults-table.md.

[Copilot]

generate_settings_table_markdown() claims to output default settings, but it serialises the module-level settings = Settings() instance. Because Settings reads from environment variables / .env, the generated docs table can become non-deterministic (and reflect build-time overrides rather than true defaults). Consider generating values from Settings.model_fields defaults (and any derived defaults like db_url) or otherwise constructing a Settings instance with env/dotenv sources disabled for this docs-only output.