Skip to content

Conversation

@bkeryan
Copy link
Collaborator

@bkeryan bkeryan commented May 2, 2025

What does this Pull Request accomplish?

Enable the intersphinx to automatically hyperlink to NumPy docs.

Change --with docs to --only main,docs in check_docs.yml workflow to avoid installing lint/test dependencies.

Why should this Pull Request be merged?

Improve documentation quality.

What testing has been done?

PR build

@bkeryan bkeryan requested a review from csjall as a code owner May 2, 2025 00:44
@github-actions
Copy link
Contributor

github-actions bot commented May 2, 2025

Test Results

   10 files  ±0     10 suites  ±0   24s ⏱️ -1s
  511 tests ±0    511 ✅ ±0  0 💤 ±0  0 ❌ ±0 
5 110 runs  ±0  5 110 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 97572e4. ± Comparison against base commit 758924a.

♻️ This comment has been updated with latest results.

@bkeryan
Copy link
Collaborator Author

bkeryan commented May 2, 2025

The NumPy hyperlinks are a bit hit-or-miss.
image

https://stackoverflow.com/questions/21538983/specifying-targets-for-intersphinx-links-to-numpy-scipy-and-matplotlib has some potential reasons why.

@bkeryan bkeryan merged commit ecc7aab into main May 2, 2025
14 checks passed
@bkeryan bkeryan deleted the users/bkeryan/update-docs-config branch May 2, 2025 16:09
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