From 0ac8419abf36336fe9866b81516fa94149364c2f Mon Sep 17 00:00:00 2001 From: Kazuya Takei Date: Fri, 23 Dec 2022 00:18:21 +0900 Subject: [PATCH] doc: Update usage --- README.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.rst b/README.rst index e244d42..c3d4ee7 100644 --- a/README.rst +++ b/README.rst @@ -24,6 +24,9 @@ Installation Usage ===== +When you write ``:pypi:`rst-pypi-ref``` into reStructuredText source, +this appends ref to PyPI URL for ``rst-pypi-ref``. + Simple usage ------------ @@ -43,3 +46,14 @@ With Sphinx extensions = [ "rst_pypi_ref.sphinx", ] + +For other docutils app +---------------------- + +In entrypoint (before parse reST source), Call ``rst_pypi_ref.core.bootstrap``. + +.. code-block:: python + + from rst_pypi_ref.core import bootstrap + + bootstrap()