Documentation deployment doesn't work anymore #489
Merged
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.
#485
Note: I have included fixes for each of the warnings logged during the docs' build process. According to the warning messages, type annotations wouldn't show up for the specified vars unless the warnings were fixed.
This being my first PR I worked primarily via the advice given in the description of the original bug i.e. narrow down which commit broke the docs. I tried reverting each commit one at a time (after checking out v0.64.2) however the
RecursionError
would still occur. After taking a closer look at the stack trace, and also messing with the markdown file and noticing that the presence of theidentifier
(ex:python_on_whales.docker_client.DockerClient
) would cause the issue, I focused my efforts towards looking at issues with themkdocstrings-python
package. I couldn't find much aboutjinja2
breakingmkdocs
(except for mkdocs/mkdocs#2799), however I did find good amounts of discussion regardingGriffe
causing issues (mkdocstrings/mkdocstrings#382, and mkdocstrings/griffe#79). According to the changelog,mkdocstrings-python
enforced a version upper bound ongriffe
in version1.3
, hence why I chose to bump to this particular version. I tried out 1.2 as well however still ran into the same issue.