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.

Sign up for GitHub

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

Jump to bottom

Pydantic models docs are broken on the mkdocs site with new renderer #1353

Closed
ml-evs opened this issue Oct 4, 2022 · 2 comments
Closed

Pydantic models docs are broken on the mkdocs site with new renderer #1353

ml-evs opened this issue Oct 4, 2022 · 2 comments
Assignees
@ml-evs
Labels
docs Issues pertaining to documentation.

Comments

@ml-evs
Copy link
Member

ml-evs commented Oct 4, 2022

The links at https://www.optimade.org/optimade-python-tools/latest/all_models must have stopped working at some point
@ml-evs ml-evs added docs Issues pertaining to documentation. skip_changelog Use this label to omit this PR/issue from the CHANGELOG. labels Oct 4, 2022
@ml-evs ml-evs self-assigned this Oct 4, 2022
@ml-evs
Copy link
Member Author

ml-evs commented Oct 4, 2022

Last working version was v0.18.0, v0.19.0 failed, probably related to switching to the new mkdocstrings handler, griffe

@ml-evs
Copy link
Member Author

ml-evs commented Oct 4, 2022

Relatedly, griffe does not have additional support for pydantic as the old handler did, so the model docs look a bit rubbish even when they do work.

ml-evs added a commit that referenced this issue Oct 4, 2022
@ml-evs
Revert to legacy mkdocstrings handler to improve pydantic docs (closes \
24eecc5 
#1353)
ml-evs added a commit that referenced this issue Oct 4, 2022
@ml-evs
Revert to legacy mkdocstrings handler to improve pydantic docs (closes …
aecb580 
…#1353)
@ml-evs ml-evs closed this as completed in a95b987 Oct 5, 2022
@ml-evs ml-evs removed the skip_changelog Use this label to omit this PR/issue from the CHANGELOG. label Oct 5, 2022
@ml-evs ml-evs changed the title All models docs are broken on the mkdocs site Pydantic models docs are broken on the mkdocs site with new renderer Oct 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ml-evs ml-evs

Labels
docs Issues pertaining to documentation.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ml-evs