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

Revert sphinx version to <6.0.0 #708

Merged
merged 4 commits into from
Jan 11, 2023

Conversation

ascillitoe
Copy link
Contributor

Revert sphinx to <6.0.0 since the dependabot CI was not actually testing the new 6.x versions. See #700 (comment). sphinx-autodoc-typehints was also bumped so this has been reverted.

Before the bump to 6.x versions we were on <5.1.0. 5.1.x and 5.2.x failed for us due to issues with nbsphinx. However, I've now upgraded to <6.0.0 because 5.3.0 appears to work OK (see below).

@ascillitoe
Copy link
Contributor Author

Docs compilation errors/warnings with sphinx 5.3.0:

/home/ascillitoe/Software/alibi-detect/alibi_detect/models/pytorch/trainer.py:docstring of alibi_detect.models.pytorch.trainer:1: WARNING: duplicate object description of alibi_detect.models.pytorch.trainer, other instance in api/alibi_detect.models.pytorch, use :noindex: for one of them
/home/ascillitoe/Software/alibi-detect/alibi_detect/models/tensorflow/resnet.py:docstring of alibi_detect.models.tensorflow.resnet:1: WARNING: duplicate object description of alibi_detect.models.tensorflow.resnet, other instance in api/alibi_detect.models.tensorflow, use :noindex: for one of them
/home/ascillitoe/Software/alibi-detect/alibi_detect/models/tensorflow/trainer.py:docstring of alibi_detect.models.tensorflow.trainer:1: WARNING: duplicate object description of alibi_detect.models.tensorflow.trainer, other instance in api/alibi_detect.models.tensorflow, use :noindex: for one of them
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] overview/saving                                                                                                                                                                          
generating indices... genindex py-modindex done
copying notebooks ... [100%] od/methods/vaegmm.ipynb                                                                                                                                                              
highlighting module code... [100%] alibi_detect.utils.warnings                                                                                                                                                    
writing additional pages... search done
copying images... [100%] _static/Alibi_Detect_Logo_rgb.png                                                                                                                                                        
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 4 warnings.

and previously with spinx 5.0.1:

/home/ascillitoe/Software/alibi-detect/alibi_detect/models/pytorch/trainer.py:docstring of alibi_detect.models.pytorch.trainer:1: WARNING: duplicate object description of alibi_detect.models.pytorch.trainer, other instance in api/alibi_detect.models.pytorch, use :noindex: for one of them
/home/ascillitoe/Software/alibi-detect/alibi_detect/models/tensorflow/resnet.py:docstring of alibi_detect.models.tensorflow.resnet:1: WARNING: duplicate object description of alibi_detect.models.tensorflow.resnet, other instance in api/alibi_detect.models.tensorflow, use :noindex: for one of them
/home/ascillitoe/Software/alibi-detect/alibi_detect/models/tensorflow/trainer.py:docstring of alibi_detect.models.tensorflow.trainer:1: WARNING: duplicate object description of alibi_detect.models.tensorflow.trainer, other instance in api/alibi_detect.models.tensorflow, use :noindex: for one of them
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] overview/saving                                                                                                                                                                           
generating indices... genindex py-modindex done
copying notebooks ... [100%] od/methods/vaegmm.ipynb                                                                                                                                                               
highlighting module code... [100%] alibi_detect.utils.warnings                                                                                                                                                     
writing additional pages... search done
copying images... [100%] _static/Alibi_Detect_Logo_rgb.png                                                                                                                                                         
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 4 warnings.

This looks to be the same.

@ascillitoe ascillitoe merged commit f0b57b4 into SeldonIO:master Jan 11, 2023
@ascillitoe ascillitoe deleted the fix/revert_sphinx_versions branch January 11, 2023 12:06
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

1 participant