Make the docs build successfully with mkdocstrings-python 2.0 #1575
+12
−10
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.
This fixes CI failure which can be seen here.
In mkdocstrings/python@5ebeda6 (1.14 release), two changes happened:
importwas renamed toinventories;optionswas deprecated, and they should be now passed inoptions.extra.The old config kept working in 1.x releases, but since mkdocstrings/python@c10afdb (2.0 release), it no longer works.
I bumped mkdocstrings dependency to 0.28.3, because it in turn depends on mkdocstrings-python new enough to contain the first commit (see mkdocstrings/mkdocstrings@ba9003e).
While working on this, I noticed that links to code are broken in the current release, because the tag name is
3.10.0but_get_version()returns just3.10. We should make this consistent, but that’s a separate issue.