Skip to content

Conversation

@skoudoro
Copy link
Collaborator

All in the title above.

  • fix Documentation examples #79
  • zero warnings allowed during docs generation.
  • mutliple functions docstring normalized to the Numpy Stantard

Install with all dependencies

pip install -e ".[all]"

Set up development environment (fetches upstream tags)

spin setup

build docs:

spin docs --open --clean

some screenshots:
image
image
image
image

@skoudoro skoudoro requested review from arokem and frheault January 16, 2026 22:24
@codecov
Copy link

codecov bot commented Jan 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (master@43edfbb). Learn more about missing BASE report.

Additional details and impacted files
@@            Coverage Diff            @@
##             master      #90   +/-   ##
=========================================
  Coverage          ?   58.96%           
=========================================
  Files             ?       12           
  Lines             ?     2364           
  Branches          ?        0           
=========================================
  Hits              ?     1394           
  Misses            ?      970           
  Partials          ?        0           
Flag Coverage Δ
unittests 58.96% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@skoudoro skoudoro force-pushed the update-doc branch 3 times, most recently from 27cbede to a6c7836 Compare January 17, 2026 01:22
@skoudoro
Copy link
Collaborator Author

ok all green , merging for now.

More update coming concerning the doc

@skoudoro skoudoro merged commit 04235be into tee-ar-ex:master Jan 17, 2026
16 checks passed
@arokem arokem mentioned this pull request Jan 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation examples

1 participant