Skip to content

Commit

Permalink
Improve docs (#32)
Browse files Browse the repository at this point in the history
* add more `rst` style hyperlinks

* Update poetry.lock
  • Loading branch information
baseplate-admin authored May 9, 2024
1 parent c19cc0c commit a7565d6
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 20 deletions.
5 changes: 4 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Welcome to resvg_py's documentation!
========================================

Safe bindings for `resvg <https://github.com/RazrFalcon/resvg>`_
Safe bindings for `resvg`_

.. toctree::
:maxdepth: 2
Expand All @@ -23,3 +23,6 @@ Indices and tables

* :ref:`genindex`
* :ref:`search`


.. _resvg: https://docs.rs/resvg/latest/resvg/
5 changes: 4 additions & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Requirements

Python 3.8 to 3.12 supported.

Currently it builds the non-EOL python versions with `maturin <https://github.com/PyO3/maturin>`_ github-actions.
Currently it builds the non-EOL python versions with `maturin`_ github-actions.


Installation
Expand All @@ -17,3 +17,6 @@ Installation
.. code-block:: python
python -m pip install resvg_py
.. _maturin: https://github.com/PyO3/maturin
19 changes: 1 addition & 18 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a7565d6

Please sign in to comment.