DiamondLightSource / httomo

High-throughput tomography pipeline
https://diamondlightsource.github.io/httomo/
Other
7 stars 4 forks source link

Fix docs build warnings and generate API docs with `autosummary` extension #494

Closed yousefmoazzam closed 1 month ago

yousefmoazzam commented 1 month ago

Fixes #468 Fixes #486 Fixes #487 Fixes #490 Doesn't solve #492, but instead finds a workaround via not using | in conjunction with certain types

Checklist

yousefmoazzam commented 1 month ago

All warning in the docs build locally are gone, but the CI has one warning:

/home/runner/work/httomo/httomo/docs/source/developers/api.rst:4: WARNING: autosummary: failed to import httomo.cli.
Possible hints:
* AttributeError: module 'httomo' has no attribute 'cli'
* ImportError: cannot import name '__version__' from 'httomo' (/home/runner/work/httomo/httomo/httomo/__init__.py)
* ImportError: 

Since it appears in CI only and not locally, it may need a bit more time to debug, so I'll make an issue for it to tackle after this PR; it's small in comparison to the main aim of this PR which was to: