Skip to content

Commit

Permalink
chore(readme): fix tests and coverage badges.
Browse files Browse the repository at this point in the history
  • Loading branch information
Yannick-Dayer committed Jul 11, 2024
1 parent 5abff60 commit a3c68aa
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ SPDX-FileCopyrightText: Copyright © 2022 Idiap Research Institute <contact@idia
SPDX-License-Identifier: BSD-3-Clause
-->

[![latest-docs](https://img.shields.io/badge/docs-latest-orange)](https://auto-intersphinx.readthedocs.io/en/latest/)
<!-- [![build](https://TODO/idiap/auto-intersphinx/badges/main/pipeline.svg)](https://github.com/idiap/auto-intersphinx/actions) -->
<!-- [![coverage](https://TODO/idiap/auto-intersphinx/badges/main/coverage.svg)](https://www.idiap.ch/software/biosignal/docs/software/auto-intersphinx/main/coverage/index.html) -->
[![repository](https://img.shields.io/badge/github-project-darkblue)](https://github.com/idiap/auto-intersphinx)
[![latest-docs](https://img.shields.io/badge/docs-latest-orange.svg)](https://auto-intersphinx.readthedocs.io/en/latest/)
[![tests](https://github.com/idiap/auto-intersphinx/main/actions/workflows/tests.svg)](https://github.com/idiap/auto-intersphinx/actions)
[![coverage](https://raw.githubusercontent.com/idiap/auto-intersphinx/python-coverage-comment-action-data/badge.svg)](https://htmlpreview.github.io/?https://github.com/idiap/auto-intersphinx/python-coverage-comment-action-data/htmlcov/index.html)
[![repository](https://img.shields.io/badge/github-project-darkblue.svg)](https://github.com/idiap/auto-intersphinx)

# Automatically Links Package Documentation from Their Names

This package contains a [Sphinx](https://www.sphinx-doc.org/) plugin that can
fill
[intersphinx](https://www.sphinx-doc.org/en/main/usage/extensions/intersphinx.html)
mappings based on package names. It simplifies the use of that plugin by
removing the need of knowing URLs for various API catologs you may want to
removing the need of knowing URLs for various API catalogs you may want to
cross-reference.

For installation and usage instructions, check-out our documentation.

0 comments on commit a3c68aa

Please sign in to comment.