Metadata-Version: 2.4
Name: rst-package-refs
Version: 0.2.0
Summary: reStrucuturedText's custom roles and role builder kit for package registries of any languages.
Project-URL: Home, https://github.com/attakei/rst-package-refs
Project-URL: Repository, https://github.com/attakei/rst-package-refs
Author-email: Kazuya Takei <myself@attakei.net>
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup :: reStructuredText
Requires-Python: >=3.9
Requires-Dist: docutils
Provides-Extra: sphinx
Requires-Dist: sphinx; extra == 'sphinx'
Description-Content-Type: text/x-rst

================
rst-package-refs
================

.. note:: This is experimental package.

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

Installation
============

.. code:: console

   pip install rst-package-refs

Usage
=====

Command line test
-----------------

.. code:: console

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

With Sphinx
-----------

.. code:: python

   extensions = [
       "rst_package_refs.sphinx",
   ]

.. code:: rst

   This uses :npm:`react`.

Set up for local development
============================

Pre-requirements
----------------

* `Rye <https://rye-up.com/>`_
* `pre-commit <https://pre-commit.com/>`_
* Git

Set up
------

.. code:: console

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