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

[SYNPY-1423] update mkdocstrings dependency for 1.8.0 #1145

Merged
merged 5 commits into from
Nov 1, 2024

Conversation

danlu1
Copy link
Contributor

@danlu1 danlu1 commented Nov 1, 2024

Problem:

  1. When using mkdocstrings < 1.8.0, custom CSS is used to define symbol type before heading and in toc.
  2. We want to render cross-references for type annotations in signatures for modules from the standard library.
  3. Docstrings in json_schema.py are not following Google Style.

Solution:

  1. Remove the customization and implemented standard solution of showing symbol_type in headings and toc.
  2. Implemented singnature cross-references
  3. Update docstrings in json_schema.py

@danlu1 danlu1 requested a review from a team as a code owner November 1, 2024 17:55
@pep8speaks
Copy link

pep8speaks commented Nov 1, 2024

Hello @danlu1! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

Line 383:89: E501 line too long (147 > 88 characters)
Line 407:89: E501 line too long (147 > 88 characters)

Comment last updated at 2024-11-01 19:38:41 UTC

Copy link
Contributor

@BryanFauble BryanFauble left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I started up the mkdocs site locally and everything is looking good! Thanks for making the changes here.

I really like how signature_crossrefs is working and being able to click the signatures and be taken to the referenced types.

@danlu1 danlu1 merged commit 13c1c6e into develop Nov 1, 2024
15 of 17 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.

3 participants