Skip to content

docs: update sphinx conf.py to use cp_typing. #8236

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
Merged
merged 1 commit into from
Jul 30, 2023
Merged

docs: update sphinx conf.py to use cp_typing. #8236

merged 1 commit into from
Jul 30, 2023

Conversation

kbsriram
Copy link

  • Adds circuitpython_typing to the intersphinx configuration.
  • Adds a workaround to resolve TypeAliased references.

Fixes #8119

@kbsriram
docs: update sphinx conf.py to use cp_typing.
a9da9bc 
- Adds circuitpython_typing to the intersphinx configuration.
- Adds a workaround to resolve TypeAliased references.

Fixes adafruit#8119
jepler
jepler approved these changes Jul 30, 2023
View reviewed changes
Copy link

@jepler jepler left a comment

Choose a reason for hiding this comment

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

Thanks! this makes sense. I didn't look at the generated docs, though.

@kbsriram
Copy link
Author

Thx for the quick turnaround! I downloaded the docs.zip artifact from the passing workflow for this PR, and did a spot check on a few files - they seem to have a clickable link in place now.
image

@jepler jepler merged commit e8c9eaa into adafruit:main Jul 30, 2023
@jepler
Copy link

jepler commented Jul 30, 2023

confirmed it's now correct in our published docs as well: https://docs.circuitpython.org/en/latest/shared-bindings/analogbufio/index.html#analogbufio.BufferedIn.readinto

@jepler
Copy link

jepler commented Jul 30, 2023

Thanks for your sleuthing and a workable workaround!

@kbsriram kbsriram deleted the fix-circuitpython-8119 branch July 30, 2023 15:52
osandov added a commit to osandov/drgn that referenced this pull request Nov 1, 2023
@osandov
drgndoc: work around Sphinx not linking to type aliases in annotations
1636bbd 
Sphinx normally makes type names in annotations links to the
documentation for that type, but this doesn't work for type aliases
(like drgn.Path). See sphinx-doc/sphinx#10785. Add a workaround inspired
by adafruit/circuitpython#8236.

Signed-off-by: Omar Sandoval <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jepler jepler jepler approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: Missing references to ReadableBuffer, WritableBuffer etc. circuitpython_typing types
2 participants
@kbsriram @jepler