Migrate in-code docs to Google docstyle, document the public API, and gate CI on both - #274

Open

kozlov721 wants to merge 87 commits into

mainfrom

docs/google-docstyle

Commits on Aug 13, 2026

Migrate in-code docs to Google docstyle

kozlov721
and
claude
committed
6894fae
Make the API docs build warning-free

kozlov721
and
claude
committed
d61f68f
Gate CI on a warning-free docs build

kozlov721
and
claude
committed
afe765c
Document the public API and enforce it

kozlov721
and
claude
committed
e82d194
Gate CI on prek, and switch off pre-commit

kozlov721
and
claude
committed
a12d769
cleanup
kozlov721
committed
d0b03bf
Use the reST constructs the docs already support

kozlov721
and
claude
committed
62e9974
Satisfy the current ruff pre-commit pins in the RVC4 analyzer

kozlov721
and
claude
committed
a943ccd
cleanup
kozlov721
committed
42181c1
Rename `target`/`packages` terminology to `platform`

kozlov721
and
claude
committed
6d7caf0
Make implementation-detail class members private

kozlov721
and
claude
committed
6e1e827
Add `typos` pre-commit check and fix the typos it found

kozlov721
and
claude
committed
065898f
updated requirements
kozlov721
committed
ea57b62

Commits on Aug 14, 2026

type fixes
kozlov721
committed
a9f7029
less verbose builds
kozlov721
committed
2265af1
fix ci
kozlov721
committed
153573d
don't upload coverage on manual trigger
kozlov721
committed
bb781bf
cleanup
kozlov721
committed
468d896
fix
kozlov721
committed
b1a91c1
Merge branch 'main' into chore/pre-docs-cleanup
kozlov721
committed
6920d26
Merge branch 'main' into chore/pre-docs-cleanup
kozlov721
committed
ce9de96
Restore the per-platform install extras

kozlov721
and
claude
committed
76fedbb
Guard the channel-first transpose on the array rank

kozlov721
and
claude
committed
0178fac
Expose the exporter inputs and model name

kozlov721
and
claude
committed
4fa29e5
Select the RVC3 tests when the RVC2 code changes

kozlov721
and
claude
committed
29b51dd
Run the pyright that the dev extra pins

kozlov721
and
claude
committed
abbc05c
Omit the new RVC4 utils module from coverage

kozlov721
and
claude
committed
8f84a12
Move the private members to their conventional places

kozlov721
and
claude
committed
908d6ee
Correct the stale docstrings and the log message

kozlov721
and
claude
committed
a5847e6
Type the subprocess output as bytes

kozlov721
and
claude
committed
ebf90e5
Remove the last `Any`

kozlov721
and
claude
committed
c5ba06d
Rename the tests that still say "target"

kozlov721
and
claude
committed
a36e3b0
Correct the stale commands and paths in the README

kozlov721
and
claude
committed
fae869d
Rewrap the staged-token comment

kozlov721
and
claude
committed
0f02177

Commits on Aug 15, 2026

Replace the duplicated `input_model` guard with a helper

kozlov721
and
claude
committed
2be9311
Stop `human_size` writing a unit `parse_size` cannot read

kozlov721
and
claude
committed
efec58d
Exclude the stat fallbacks the cache sweep cannot reach

kozlov721
and
claude
committed
0fa23d4
Cover the config validators and the coercion helpers

kozlov721
and
claude
committed
65823db
Cover the size and the directory helpers

kozlov721
and
claude
committed
f08f475
Cover the output directory and the slug refusals

kozlov721
and
claude
committed
da4fb6c
Cover the TFLite tensor errors

kozlov721
and
claude
committed
7c0071c
Cover what the exporter run leaves behind

kozlov721
and
claude
committed
176f5ad
Cover the inferer stand-ins

kozlov721
and
claude
committed
031267f
Cover the entrypoint test helpers

kozlov721
and
claude
committed
c8a2328
Cover the input staging edge cases

kozlov721
and
claude
committed
c3061e5

Commits on Aug 16, 2026

Move the type gate and its coverage to a follow-up PR

kozlov721
and
claude
committed
49f7ec0
Type the utils and the test helpers

kozlov721
and
claude
committed
d202ca1
Cover the size, staging and TFLite paths

kozlov721
and
claude
committed
2c0272e
Add the pyright type gate

kozlov721
and
claude
committed
c6966bd
fix typo;
kozlov721
committed
e4775e7
nitpicks
kozlov721
committed
c42445d
Type the utils and the test helpers

kozlov721
and
claude
authored
b648362
Cover the size, staging and TFLite paths

kozlov721
and
claude
authored
6ef93d0
Add the pyright type gate

kozlov721
and
claude
authored
080c001
Merge branch 'chore/type-gate-and-coverage' of github.com:luxonis/modelconverter into chore/type-gate-and-coverage
kozlov721
committed
f762ddf
Name the real types behind the test object annotations

kozlov721
and
claude
committed
810231b
Fix the crash on a Split-Concat that feeds nothing

kozlov721
and
claude
committed
6a46320
Report the DSP power collapse value as optional

kozlov721
and
claude
committed
4148dda
Name the real type of the HTTP header getter

kozlov721
and
claude
committed
3834769
Correct the RVC4 analyze and visualize collection types

kozlov721
and
claude
committed
08613eb
Type the config literals that hold mixed values

kozlov721
and
claude
committed
44dd48a
Narrow the model name that the archive supplies

kozlov721
and
claude
committed
04a7b00
Fix the types in the evaluation tests

kozlov721
and
claude
committed
f943a2b
Name the real types in the progress handler

kozlov721
and
claude
committed
9c6e690
remove unused and unresolvable extras
kozlov721
committed
8f4e633

Commits on Aug 31, 2026

Merge branch 'main' into chore/type-gate-and-coverage

kozlov721
and
claude
committed
0bffbad
Detect the release branch on every event

kozlov721
and
claude
committed
0543c9d
Pin the pyright that the type gate runs

kozlov721
and
claude
committed
3b9268a
Name the RVC4 analyzer dtype parameter

kozlov721
and
claude
committed
b0e804a
Skip the FIFO test where mkfifo is absent

kozlov721
and
claude
committed
459e03a
Merge branch 'chore/type-gate-and-coverage' into docs/google-docstyle

kozlov721
and
claude
committed
cf06263
Finish the Epytext conversion in base_benchmark

kozlov721
and
claude
committed
1ca2b8d
Fail the doctests on an unexpected import error

kozlov721
and
claude
committed
91bce96
Name the real attributes in the analyzer and visualizer docs

kozlov721
and
claude
committed
950ea73
Describe which commands run in a container

kozlov721
and
claude
committed
9298f3f
Document the errors the config and archive helpers raise

kozlov721
and
claude
committed
53268b4
Set the google docstring convention

kozlov721
and
claude
committed
2ab1c69
Remove the empty CLAUDE.md

kozlov721
and
claude
committed
17c6671
Remove the unreachable model name type guard

kozlov721
and
claude
committed
9445cf5
Read the download response headers directly

kozlov721
and
claude
committed
ed062a1
Take the first successor without a generator

kozlov721
and
claude
committed
9fffbab
Match the file's boolean assertion style

kozlov721
and
claude
committed
af76db5
updated readme
kozlov721
committed
0bc9ff2
cleanup
kozlov721
committed
e99a4aa
Merge branch 'chore/type-gate-and-coverage' into docs/google-docstyle

kozlov721
and
claude
committed
19fdba8

Commits on Sep 1, 2026

fixes
kozlov721
committed
4afdf43
Merge branch 'main' into docs/google-docstyle

kozlov721
and
claude
committed
a1baf7d