https://github.com/attakei/rst-package-refs

https://github.com/attakei/rst-package-refs

docutils hacktoberfest pypi python

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/attakei/rst-package-refs
• Owner: attakei
• License: apache-2.0
• Created: 2024-02-18T15:49:31.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-25T04:44:18.000Z (almost 2 years ago)
• Last Synced: 2025-06-15T21:47:50.688Z (8 months ago)
• Topics: docutils, hacktoberfest, pypi, python
• Language: Python
• Homepage:
• Size: 42 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
================

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

   

       

           

               react

With Sphinx

-----------

.. code:: python

   extensions = [

       "rst_package_refs.sphinx",

   ]

.. code:: rst

   This uses :npm:`react`.

Set up for local development

============================

Pre-requirements

----------------

* `Rye `_

* `pre-commit `_

* Git

Set up

------

.. code:: console

   git clone https://github.com/attakei/rst-package-refs.git

   cd /path/to/rst-package-refs

   rye run setup