rst-pypi-ref 0.4.0

reStructuredText custom role to add ref to PyPI.

reStructuredText custom role to refer PyPI packages.

Description

This is python package to provide features to refer to PyPI in docutils (and more).

Included features:

• reStructuredText role

• Sphinx extension

Installation

pip install rst-pypi-ref

Usage

When you write :pypi:`rst-pypi-ref` into reStructuredText source, this appends ref to PyPI URL for rst-pypi-ref.

Supporting syntax

• Package name only: :pypi:`rst-pypi-ref`

• Explicit version: :pypi:`rst-pypi-ref==0.2.0`

• Change display text: :pypi:`PyPI Link <rst-pypi-ref>`

  • There package name in between < and >.

Simple usage

$ echo ':pypi:`rst-pypi-ref`' | python -m rst_pypi_ref.cli
<document source="<stdin>">
    <paragraph>
        <reference refuri="https://pypi.org/project/rst-pypi-ref">
            rst-pypi-ref

With Sphinx

extensions = [
    "rst_pypi_ref.sphinx",
]

For other docutils app

In entrypoint (before parse reST source), Call rst_pypi_ref.core.bootstrap.

from rst_pypi_ref.core import bootstrap

bootstrap()

Contibuting

See CONTIBUTING note.