Fix missing docs#336
Merged
andrewilyas merged 1 commit intolibffcv:v1.1.0from Jul 5, 2023
wouterzwerink:v1.1.0
Merged
Conversation
Contributor
|
Thanks! I changed sphinx to use v6 on the main branch, hopefully that works! |
Author
|
@andrewilyas thank you! Two things:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Would be great if someone could use this to update the docs, especially the missing docs for Loader.
closes #319