Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 28, 2025

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 links
  • newton_method.md included technical details and a "GPU:" prefix
  • All links used hardcoded URLs to JAX lectures
  • Inconsistent wording and formatting between admonitions

After:
Both files now use the same clean, standardized template with proper intersphinx references:

```{seealso}
A version of this lecture using [JAX](https://github.com/jax-ml/jax) is {doc}`available here <jax:lecture_name>`
```

Infrastructure Updates:

  • Added JAX intersphinx mapping to lectures/_config.yml for proper cross-referencing
  • Converted all hardcoded JAX lecture URLs to use {doc} intersphinx references
  • Updated additional JAX reference in newton_method.md for consistency

Files Modified

  1. lectures/_config.yml - Added JAX intersphinx mapping
  2. lectures/wealth_dynamics.md - Updated seealso admonition and converted URL to intersphinx reference
  3. lectures/newton_method.md - Updated seealso admonition and converted all JAX URLs to intersphinx references

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.

Co-authored-by: mmcky <8263752+mmcky@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] [style-task] Check that all see also follow a standard pattern Standardize seealso admonitions to follow consistent format Aug 28, 2025
Copilot finished work on behalf of mmcky August 28, 2025 04:03
@Copilot Copilot AI requested a review from mmcky August 28, 2025 04:03
@mmcky
Copy link
Contributor

mmcky commented Aug 28, 2025

  • @mmcky update these links to use doc and inter sphinx.

@mmcky
Copy link
Contributor

mmcky commented Aug 28, 2025

@copilot can we use the following standardised template

A version of this lecture using [JAX](https://github.com/jax-ml/jax) is [available here](URL)

…hinx links

Co-authored-by: mmcky <8263752+mmcky@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Aug 28, 2025

  • @mmcky update these links to use doc and inter sphinx.

Updated the links to use doc and intersphinx as requested. Added JAX intersphinx mapping to _config.yml and converted all hardcoded JAX lecture URLs to intersphinx references using {doc} format. (commit d11b946)

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:

  • jax.quantecon.org
    • Triggering command: curl -s REDACTED (dns block)
    • Triggering command: curl -s -I REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copy link
Contributor Author

Copilot AI commented Aug 28, 2025

@copilot can we use the following standardised template

...

Updated both seealso admonitions to use the standardized template with JAX reference as requested. The format now includes the JAX link and uses intersphinx {doc} references for better maintainability. (commit d11b946)

@Copilot Copilot AI changed the title Standardize seealso admonitions to follow consistent format Standardize seealso admonitions with JAX template and intersphinx references Aug 28, 2025
Copilot finished work on behalf of mmcky August 28, 2025 08:01
@mmcky
Copy link
Contributor

mmcky commented Aug 28, 2025

  • intersphinx mappings added
  • seealso is now standardised in this lecture series.

@mmcky mmcky marked this pull request as ready for review August 28, 2025 08:02
@mmcky mmcky added ready and removed review labels Aug 28, 2025
Copy link

github-actions bot commented Aug 28, 2025

@github-actions github-actions bot temporarily deployed to pull request August 28, 2025 08:16 Inactive
@github-actions github-actions bot temporarily deployed to pull request August 28, 2025 08:16 Inactive
@mmcky mmcky merged commit 39b39c9 into main Aug 29, 2025
7 checks passed
@mmcky mmcky deleted the copilot/fix-580 branch August 29, 2025 02:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[style-task] Check that all see also follow a standard pattern
2 participants