.. image:: https://img.shields.io/pypi/v/rst.linker.svg
   :target: https://pypi.org/project/rst.linker

.. image:: https://img.shields.io/pypi/pyversions/rst.linker.svg

.. image:: https://img.shields.io/travis/jaraco/rst.linker/master.svg
   :target: https://travis-ci.org/jaraco/rst.linker

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Code style: Black

.. .. image:: https://img.shields.io/appveyor/ci/jaraco/rst-linker/master.svg
..    :target: https://ci.appveyor.com/project/jaraco/rst-linker/branch/master

.. image:: https://readthedocs.org/projects/rstlinker/badge/?version=latest
   :target: https://rstlinker.readthedocs.io/en/latest/?badge=latest


``rst.linker`` provides a routine for adding links and performing
other custom replacements to reStructuredText files as a Sphinx
extension.

Usage
=====

In your sphinx ``conf`` file, include ``rst.linker`` as an extension
and then add a ``link_files`` configuration section describing
the substitutions to make. For an example, see `rst.linker's own
conf.py
<https://github.com/jaraco/rst.linker/blob/master/docs/conf.py>`_
or read the source to learn more about the the linkers provided.
