You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# sphinx-peek
2
2
3
+
[![PyPI][pypi-badge]][pypi-link]
4
+
3
5
> Sphinx extension for peeking at references
4
6
5
7
**In Development!**
@@ -52,3 +54,6 @@ This extension adapts the approach of `sphinx-preview`, but:
52
54
3. Fixes some bugs with the scroll-to-anchor behaviour, and preview window positioning
53
55
4. Adds anchoring of the preview window to the reference, during scrolling and window resizing
54
56
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.
0 commit comments