https://github.com/compwa/sphinx-api-relink

Relink type hints in your Sphinx API
https://github.com/compwa/sphinx-api-relink

Last synced: 5 months ago
JSON representation

Relink type hints in your Sphinx API

• Host: GitHub
• URL: https://github.com/compwa/sphinx-api-relink
• Owner: ComPWA
• License: bsd-3-clause
• Created: 2023-12-03T16:36:39.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T10:49:54.000Z (over 1 year ago)
• Last Synced: 2024-10-29T12:42:41.696Z (over 1 year ago)
• Language: Python
• Homepage:
• Size: 62.5 KB
• Stars: 1
• Watchers: 7
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# `sphinx-api-relink`

[![PyPI package](https://badge.fury.io/py/sphinx-api-relink.svg)](https://pypi.org/project/sphinx-api-relink)

[![Supported Python versions](https://img.shields.io/pypi/pyversions/sphinx-api-relink)](https://pypi.org/project/sphinx-api-relink)

[![BSD 3-Clause license](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/license/BSD-3-Clause)

[![CI status](https://github.com/ComPWA/sphinx-api-relink/workflows/CI/badge.svg)](https://github.com/ComPWA/sphinx-api-relink/actions?query=branch%3Amain+workflow%3ACI)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/sphinx-api-relink/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/sphinx-api-relink/main)

[![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)

[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)

> [!TIP]

> See all documentation at [compwa.github.io/sphinx-api-relink](https://compwa.github.io/sphinx-api-relink).