Fix missing docs - Githubissues

libffcv / ffcv

FFCV: Fast Forward Computer Vision (and other ML workloads!)

https://ffcv.io

Apache License 2.0

2.79k stars 180 forks source link

Closed wouterzwerink closed 12 months ago

wouterzwerink commented 12 months ago

Fixes missing docs of the Loader, by fixing an issue with autodoc failing the assert inside state.py.

Note: the theme used by FFCV has not been updated in a long time. It runs into deprecation issues with sphinx >=7.*. Someone already PRed a fix to the theme.

I'm able to make docs using:

pip install sphinx==6.*
pip install karma_sphinx_theme
cd docs
make html

Would be great if someone could use this to update the docs, especially the missing docs for Loader.

closes #319

andrewilyas commented 12 months ago

Thanks! I changed sphinx to use v6 on the main branch, hopefully that works!

wouterzwerink commented 12 months ago

@andrewilyas thank you! Two things:

Loader docs will still be broken without the change to INITIAL_STATE for sphinx. So depending on the schedule for ffcv 1.1, it may be worth porting that to main too.
Later versions of 6 should be fine too (I used 6.* during install), it's only 7 and up that break