Skip to content

Commit 73c084c

Browse files
committed
🔧 Add pypi link
1 parent 06fb5dd commit 73c084c

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# sphinx-peek
22

3+
[![PyPI][pypi-badge]][pypi-link]
4+
35
> Sphinx extension for peeking at references
46
57
**In Development!**
@@ -52,3 +54,6 @@ This extension adapts the approach of `sphinx-preview`, but:
5254
3. Fixes some bugs with the scroll-to-anchor behaviour, and preview window positioning
5355
4. Adds anchoring of the preview window to the reference, during scrolling and window resizing
5456
5. For development purposes, also adds [JSDoc type annotations](https://www.typescriptlang.org/docs/handbook/intro-to-js-ts.html#providing-type-hints-in-js-via-jsdoc) to the JavaScript code and uses pre-commit hooks to check the formatting and type safety of the code.
57+
58+
[pypi-badge]: https://img.shields.io/pypi/v/sphinx-peek.svg
59+
[pypi-link]: https://pypi.org/project/sphinx-peek

docs/index.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,15 @@ that can be clicked to peek at the target of the reference.
1919
Usage
2020
-----
2121

22-
Simply add ``sphinx_peek`` to your ``conf.py`` extensions list.
22+
.. image:: https://img.shields.io/pypi/v/sphinx-peek.svg
23+
:target: https://pypi.org/project/sphinx-peek/
24+
:alt: PyPI
25+
26+
Simply install and add ``sphinx_peek`` to your ``conf.py`` extensions list.
27+
28+
.. code-block:: bash
29+
30+
pip install sphinx-peek
2331
2432
.. code-block:: python
2533

0 commit comments

Comments
 (0)