https://github.com/rffontenelle/python-docs-linkcheck

Fixing problematic links from Python documentation
https://github.com/rffontenelle/python-docs-linkcheck

linkcheck python sphinx

Last synced: 30 days ago
JSON representation

Fixing problematic links from Python documentation

• Host: GitHub
• URL: https://github.com/rffontenelle/python-docs-linkcheck
• Owner: rffontenelle
• License: cc0-1.0
• Created: 2023-04-12T00:14:31.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-17T17:22:36.000Z (4 months ago)
• Last Synced: 2024-11-23T02:03:09.726Z (about 1 month ago)
• Topics: linkcheck, python, sphinx
• Homepage: https://github.com/python/cpython/issues/103484
• Size: 571 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
python-docs-linkcheck

=====================

This repository is dedicated to identifying and fixing issues with links in the [Python Documentation](https://docs.python.org/), as reported by the [Sphinx](https://www.sphinx-doc.org/) linkcheck builder. The project originated from [CPython issue #103484](https://github.com/python/cpython/issues/103484), with the goal of testing patches across various Python versions efficiently, without having to wait for the linkcheck command to complete or relying on personal hardware for multiple documentation builds.

The [linkcheck.yml](.github/workflows/linkcheck.yml) GitHub Actions workflow is designed to automate checks, including link verification, across the supported Python releases—typically the 'main' branch and the two most recent (pre-)releases.

The output from linkcheck is categorized by status (e.g., broken links, permanent redirects, temporary redirects), and committed back to this repository, to enhance readability and streamline the process of identifying and resolving issues.