Giter Club home page Giter Club logo

sphinxcontrib.external-links's Introduction

sphinxcontrib.external-links

pre-commit renovate

Sphinx extension for easily adding reusable external links.

Features

  • default list of commonly used external links
  • user configurable links
  • check documentation for hardcoded links that can be replaced
  • compatible with the Sphinx's linkcheck builder to check link integrity
  • global substitutions

Usage

external_links = {
    "Google": "https://google.com",  # matches ":link:`google`", ":link:`Google`", etc
}
external_links_substitutions = {
    "dict": ":class:`dict`",
}
Provide a link to :link:`Google` to :link:`google.com <google>`.
This thing is a |dict|.

sphinxcontrib.external-links's People

Contributors

renovate[bot] avatar itprokyle avatar pre-commit-ci[bot] avatar

Watchers

avatar avatar

sphinxcontrib.external-links's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

github-actions
.github/workflows/on-pr-target-opened.yml
  • technote-space/assign-author v1
  • release-drafter/release-drafter v6.0.0
.github/workflows/on-pr.yml
  • deepakputhraya/action-branch-name v1.0.0
.github/workflows/on-push.yml
  • actions/checkout v4
  • actions/setup-node v4
  • ITProKyle/action-setup-python v0.7.0
  • actions/checkout v4
  • ITProKyle/action-setup-python v0.7.0
  • actions/checkout v4
  • ITProKyle/action-setup-python v0.7.0
  • actions/upload-artifact v4
  • actions/checkout v4
  • actions/setup-node v4
.github/workflows/on-release.yml
  • actions/checkout v4
  • ITProKyle/action-setup-python v0.7.0
  • actions/upload-artifact v4
  • actions/checkout v4
  • actions/download-artifact v4
  • ITProKyle/action-setup-python v0.7.0
.github/workflows/release-management.yml
  • release-drafter/release-drafter v6.0.0
npm
package.json
  • @itprokyle/cspell-dict ^1.2.3
  • cspell ^8.8.3
  • pyright ^1.1.365
pep621
pyproject.toml
poetry
pyproject.toml
  • python ^3.9
  • sphinx ^7.2.6
  • pre-commit ^3.7.1
  • doc8 ^1.1.1
  • furo ^2024.5.6
  • sphinx-autobuild ^2024.4.16
  • sphinx-copybutton ^0.5.2
  • sphinx-design ^0.6.0
  • sphinxcontrib-jquery ^4.1
  • sphinxcontrib-trio ^1.1.2
  • black ^24.4.2
  • ruff ^0.4.7
  • pytest ^8.2.1
  • pytest-cov ^5.0.0
  • pytest-mock ^3.14.0
  • pytest-sugar >=1.0.0
  • pytest-xdist ^3.6.0
  • sphinx ^7.3.7
  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.