Make use of Sphinx inventories for cross references #8682
Conversation
| @@ -51,7 +51,7 @@ except ValidationError as e: | |||
| Pydantic supports the following [datetime](https://docs.python.org/library/datetime.html#available-types) | |||
| types: | |||
|
|
|||
| ### `datetime.datetime` | |||
| ### [`datetime.datetime`][] | |||
There was a problem hiding this comment.
Not sure you'd want references directly on the headings. If so, I can remove them
There was a problem hiding this comment.
🤷♀️ I think it'd be nice! Looks good.
There was a problem hiding this comment.
Just checking - have you built the docs locally to confirm that the [datetime.datetime][] style of references correctly redirects to the stdlib python docs?
There was a problem hiding this comment.
These manual references will produce warnings if they can't be resolved, failing MkDocs builds in strict mode, so the checking is kinda automated 🙂
CodSpeed Performance ReportMerging #8682 will not alter performanceComparing Summary
|
| @@ -174,6 +174,8 @@ plugins: | |||
| merge_init_into_class: true | |||
There was a problem hiding this comment.
Could be nice to add these too:
parameter_headings: true
show_signature_annotations: true
signature_crossrefs: true
There was a problem hiding this comment.
For parameter headings, you'll have to install the Insiders version of mkdocstrings-python, similar to how you install mkdocs-material:
pdm run python -m pip install https://files.scolvin.com/${MKDOCS_TOKEN}/mkdocs_material-9.4.2+insiders.4.42.0-py3-none-any.whl
https://mkdocstrings.github.io/python/insiders/installation/
Let me know if any other user (Pydantic team member or bot) needs to be added to the @pawamoy-insiders organization 🙂
There was a problem hiding this comment.
Added:
show_signature_annotations: true
signature_crossrefs: true
| @@ -51,7 +51,7 @@ except ValidationError as e: | |||
| Pydantic supports the following [datetime](https://docs.python.org/library/datetime.html#available-types) | |||
| types: | |||
|
|
|||
| ### `datetime.datetime` | |||
| ### [`datetime.datetime`][] | |||
There was a problem hiding this comment.
🤷♀️ I think it'd be nice! Looks good.
|
Do you want to continue to make progress on this PR, or do this in chunks? |
|
Maybe better in chunks, merging this will allow other PRs to make use of this feature |
Fixes #8664
This is far from complete but can give you an overview.