Change sphinx autodoc syntax #1044
Merged
Conversation
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
Collaborator
|
Our doc dependencies don't currently specify version identifiers. Should we consider fixing them? |
Collaborator
Author
|
I just added a minimum version for Sphinx and added this to the progress/what's new page. |
PGijsbers
approved these changes
Apr 9, 2021
This was referenced Apr 9, 2021
PGijsbers
pushed a commit
to Mirkazemi/openml-python
that referenced
this pull request
Feb 23, 2023
* change sphinx autodoc syntax * add minimal sphinx version for doc building
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.
Reference Issue
#1035
What does this PR implement/fix? Explain your changes.
Change sphinx autodoc configuration to use a dictionary instead of a list. I don't know when this was changed in sphinx, but I was able to pin down when this was changed in scikit-learn: scikit-learn/scikit-learn#13982
How should this PR be tested?
Build the docs locally with and without this PR using sphinx >= 3.X (the change isn't necessary for sphinx 2.X)