Skip to content

Commit

Permalink
doc: Update usage
Browse files Browse the repository at this point in the history
  • Loading branch information
attakei committed Dec 22, 2022
1 parent f0ec0fe commit 0ac8419
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------

Expand All @@ -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()

0 comments on commit 0ac8419

Please sign in to comment.