sphinx-hoverxref

v1.4.2

Sphinx extension to show tooltips with content embedded when hover a reference. For more information about how to use this package see README

Latest version published 1 month ago

License: MIT

PyPI

GitHub

Package Health Score

72 / 100

security
Security review needed
popularity
Small
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Popularity

Small

GitHub Stars: 100
Forks: 41
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package sphinx-hoverxref, we found that it has been starred 100 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Nov 18, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
2
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like sphinx-hoverxref is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 34
Open PR: 2
Last Release: 1 month ago
Last Commit: 1 month ago

Further analysis of the maintenance status of sphinx-hoverxref based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that sphinx-hoverxref demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the sphinx-hoverxref repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like sphinx-hoverxref is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: ==2.7.*, ==3.*

Age: 5 years
Latest Release: 1 month ago
Dependencies: 1 Direct / 26 Total
Versions: 20
Maintainers: 5
Wheels: OS Independent

Readme

sphinx-hoverxref

sphinx-hoverxref is a Sphinx extension to add tooltips on the cross references of the documentation with the content of the linked section.

Example

Installation

You can install sphinx-hoverxref from PyPI:

pip install sphinx-hoverxref

Or, alternatively, install it from GitHub directly (requires git):

pip install git+https://github.com/readthedocs/sphinx-hoverxref

Configuration

Add this extension in your conf.py file as:

extensions = [
 # ... other extensions here

 'hoverxref.extension',
]

Documentation

Check out the full documentation at

sphinx-hoverxref dependencies

sphinxcontrib-jquery

FAQs

What is sphinx-hoverxref?

Sphinx extension to show tooltips with content embedded when hover a reference. Visit Snyk Advisor to see a full health score report for sphinx-hoverxref, including popularity, security, maintenance & community analysis.

Is sphinx-hoverxref popular?

The python package sphinx-hoverxref receives a total of 8,605 weekly downloads. As such, sphinx-hoverxref popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is sphinx-hoverxref well maintained?

We found that sphinx-hoverxref demonstrated a healthy version release cadence and project activity. It has a community of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is sphinx-hoverxref safe to use?

While scanning the latest version of sphinx-hoverxref, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 3 December-2024, at 11:46 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

sphinx-hoverxref

Example

Installation

Configuration

Documentation

sphinx-hoverxref dependencies

FAQs

What is sphinx-hoverxref?

Is sphinx-hoverxref popular?

Is sphinx-hoverxref well maintained?

Is sphinx-hoverxref safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues