Describe the workflow you want to enable
The docs should be tested properly and contain helpful examples about shapiq and its content. Currently it’s still quite flaky and dodgy.
Describe your proposed solution
Rework the docs:
- fix all current issues/warnings in the docs building process
- the build docs workflow should fail when there is a warning in the build process to catch errors in the docs when changes are proposed.
- add a user guide explaining the individual parts of the library
- move the notebooks into a structured examples place
Describe alternatives you've considered, if relevant
No response
Additional context
Sklearn has an amazing doc structure which we could follow. The user guide is amazing and the examples all contain links to the correct implementations and vice versa.
Impact
None
Describe the workflow you want to enable
The docs should be tested properly and contain helpful examples about shapiq and its content. Currently it’s still quite flaky and dodgy.
Describe your proposed solution
Rework the docs:
Describe alternatives you've considered, if relevant
No response
Additional context
Sklearn has an amazing doc structure which we could follow. The user guide is amazing and the examples all contain links to the correct implementations and vice versa.
Impact
None