New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Test build to update docs to sphinx 4.x #338
Conversation
WIP WIP WIP
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Update: looks like a fix for this might be on its way in |
Looks like |
This is a draft PR to update the docs to use
sphinx>=4.0
. There is currently a problem documenting classes that inherit mocked classes (e.g.alibi_detect.utils.pytorch.kernels.DeepKernel
), which is sensitive to thesphinx
version:sphinx<3.0
: Everything is OK here.sphinx>=3.0 < 3.4.2
: Classes that inherit mocked classes are not documented. (see sphinx #8164). This is fixed insphinx 3.4.2
.sphinx>=3.4.2
: The previously missing classes are now documented, but there is a problem with the "Bases" section in the docs. Example: Inalibi_detect.utils.pytorch.kernels.DeepKernel
"Bases:torch.nn.
" instead of "Bases:torch.nn.Module
".See here for an example readthedocs build.