https://github.com/bskinn/intersphinx-gist

Github Actions bot to linkcheck the contents of the intersphinx_mappings entries hosted at: https://gist.github.com/bskinn/0e164963428d4b51017cebdb6cda5209
https://github.com/bskinn/intersphinx-gist

Last synced: 21 days ago
JSON representation

Github Actions bot to linkcheck the contents of the intersphinx_mappings entries hosted at: https://gist.github.com/bskinn/0e164963428d4b51017cebdb6cda5209

• Host: GitHub
• URL: https://github.com/bskinn/intersphinx-gist
• Owner: bskinn
• License: mit
• Created: 2021-02-17T11:33:27.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-27T01:54:48.000Z (24 days ago)
• Last Synced: 2024-10-27T02:43:46.575Z (24 days ago)
• Language: Python
• Homepage:
• Size: 123 KB
• Stars: 2
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Link-check for `intersphinx_mappings` gist

In 2016, I was trying to get

[`intersphinx`](https://www.sphinx-doc.org/en/master/usage/quickstart.html?highlight=intersphinx#intersphinx)

to work, and tossed a handful of

[`intersphinx_mapping`](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping)

entries into a [Gist](https://gist.github.com/bskinn/0e164963428d4b51017cebdb6cda5209), for future reference.

Fast-forward to 2021, when I have [pointed out to me](https://gist.github.com/bskinn/0e164963428d4b51017cebdb6cda5209#gistcomment-3633740)

that this Gist shows up quite high in Google search results for things like

"[`matplotlib intersphinx`](https://www.google.com/search?q=matplotlib+intersphinx&oq=matplotlib+intersphinx)" and

"[`numpy intersphinx`](https://www.google.com/search?q=numpy+intersphinx&oq=numpy+intersphinx)."

Soooo, I figured it probably would be a good idea to curate the Gist a bit more carefully.

This repo houses a Github Action that runs a small pytest suite, which checks that:

 1. The docs root links all point to live sites, and

 2. The `objects.inv` locations defined by the mappings point to valid inventory files,

    as checked by [`sphobjinv`](https://github.com/bskinn/sphobjinv).

The workflow is currently configured to run once every 12 hours. The log file from the workflow

is committed back to the repo every Sunday at roughly 0115 UTC; it lives

[here](https://github.com/bskinn/intersphinx-gist/blob/main/gist-check.log).

----

FWIW, if anyone reading this is having any trouble with the mappings in the Gist,

feel free to open an issue here and I'll be glad to help if I can.

----

Copyright (c) Brian Skinn 2021-2024

License: The MIT License. See [`LICENSE.txt`](https://github.com/bskinn/intersphinx-gist/blob/main/LICENSE.txt)

for full license terms.