-
-
Notifications
You must be signed in to change notification settings - Fork 53
Standardize seealso admonitions with JAX template and intersphinx references #581
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
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: mmcky <8263752+mmcky@users.noreply.github.com>
Copilot finished work on behalf of
mmcky
August 28, 2025 04:03
|
@copilot can we use the following standardised template
|
…hinx links Co-authored-by: mmcky <8263752+mmcky@users.noreply.github.com>
Updated the links to use Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Copilot finished work on behalf of
mmcky
August 28, 2025 08:01
mmcky
approved these changes
Aug 28, 2025
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR standardizes the
seealso
admonitions at the beginning of lectures to follow a consistent pattern using JAX references and intersphinx cross-references.Changes Made
Before:
wealth_dynamics.md
had redundant text with duplicate URL linksnewton_method.md
included technical details and a "GPU:" prefixAfter:
Both files now use the same clean, standardized template with proper intersphinx references:
Infrastructure Updates:
lectures/_config.yml
for proper cross-referencing{doc}
intersphinx referencesnewton_method.md
for consistencyFiles Modified
The standardized format now provides a consistent user experience and better maintainability through proper Sphinx cross-referencing.
Fixes #580.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.