rst-package-refs 0.1.0

reStrucuturedText's custom roles and role builder kit for package registries of any languages.

Note

This is experimental package.

reStructuredText’s custom roles and role builder kit for package registries of any languages.

Installation

pip install rst-package-refs

Usage

Command line test

$ echo ':npm:`react`' | python -m rst_package_refs
<document source="<stdin>">
    <paragraph>
        <reference refuri="https://www.npmjs.com/package/react">
            react

With Sphinx

extensions = [
    "rst_package_refs.sphinx",
]

This uses :npm:`react`.

Set up for local development

Pre-requirements

• Rye

• pre-commit

• Git

Set up

git clone https://github.com/attakei/rst-package-refs.git
cd /path/to/rst-package-refs
rye run setup