Skip to content
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

Merged
merged 37 commits into from Nov 3, 2021

Conversation

ascillitoe
Copy link
Contributor

@ascillitoe ascillitoe commented Sep 17, 2021

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 the sphinx 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 in sphinx 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: In alibi_detect.utils.pytorch.kernels.DeepKernel "Bases: torch.nn." instead of "Bases: torch.nn.Module".

See here for an example readthedocs build.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@ascillitoe
Copy link
Contributor Author

ascillitoe commented Sep 17, 2021

Screenshot with sphinx==4.2

sphinx_problem

Screenshot with sphinx<3.0

sphinx_working

@ascillitoe
Copy link
Contributor Author

Update: looks like a fix for this might be on its way in sphinx 4.3.0, due approx. early November. Hopefully, we can go ahead and update the docs at that point. See sphinx-doc/sphinx#9658.

@ascillitoe
Copy link
Contributor Author

Looks like sphinx v4.3.0 might take a little longer than expected to be released. Merging this now so that we can build docs for the new non-parametric detectors (#359). I will leave SeldonIO/alibi#505 open as a reminder for us to check the issue with Bases is fixed by v4.3.0 when it is released.

@ascillitoe ascillitoe marked this pull request as ready for review November 1, 2021 14:16
@ascillitoe ascillitoe merged commit 99806fe into SeldonIO:master Nov 3, 2021
@ascillitoe ascillitoe mentioned this pull request Nov 5, 2021
17 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants