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

Documentation deployment doesn't work anymore #489

Merged
merged 3 commits into from Nov 1, 2023

Conversation

kashyab12
Copy link
Contributor

#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 the identifier (ex: python_on_whales.docker_client.DockerClient) would cause the issue, I focused my efforts towards looking at issues with the mkdocstrings-python package. I couldn't find much about jinja2 breaking mkdocs (except for mkdocs/mkdocs#2799), however I did find good amounts of discussion regarding Griffe causing issues (mkdocstrings/mkdocstrings#382, and mkdocstrings/griffe#79). According to the changelog, mkdocstrings-python enforced a version upper bound on griffe in version 1.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.

@gabrieldemarmiesse
Copy link
Owner

Thank you for this thorough investigation. I'll take a look at this PR this week

@gabrieldemarmiesse
Copy link
Owner

I just made a copy of your branch and ran the deployment job for the docs from this, and it worked like a charm. Thank you for the version fix and all the other small changes to the docstrings. This is really the kind of pull requests that I love, they just work :) This PR makes me glad I'm doing open source. Many thanks :)

@gabrieldemarmiesse gabrieldemarmiesse merged commit 1a12850 into gabrieldemarmiesse:master Nov 1, 2023
37 checks passed
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