Package Health Score

93 / 100

security
No known security issues
popularity
Key ecosystem project
maintenance
Sustainable
community
Active

Explore Similar Packages

Popularity

Key ecosystem project

GitHub Stars: 6.67K
Forks: 2.13K
Contributors: 430

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package Sphinx, we found that it has been starred 6,669 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Oct 13, 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
0
M
0
L

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

License

BSD-2-Clause

Security Policy

We found a way for you to contribute to the project! Looks like Sphinx 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

Sustainable

Commit Frequency

Open Issues: 1.2K
Open PR: 113
Last Release: 2 months ago
Last Commit: 20 days ago

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

We found that Sphinx 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

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 430
Funding: Yes

A good and healthy external contribution signal for Sphinx project, which invites more than one hundred open source maintainers to collaborate on the repository.

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: >=3.10

Age: 17 years
Latest Release: 2 months ago
Dependencies: 0 Direct
Versions: 222
Maintainers: 0
Wheels: OS Independent

Not sure how to use Sphinx?

To help you get started, we've collected the most common ways that Sphinx is being used within popular public projects.

sphinx-doc / sphinx / tests / roots / test-root / conf.py View on Github

def userdesc_parse(env, sig, signode):
    x, y = sig.split(':')
    signode += addnodes.desc_name(x, x)
    signode += addnodes.desc_parameterlist()
    signode[-1] += addnodes.desc_parameter(y, y)
    return x

View more ways to use Sphinx

Sphinx

Sphinx makes it easy to create intelligent and beautiful documentation.

Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.

Features

Output formats: HTML, PDF, plain text, EPUB, TeX, manual pages, and more
Extensive cross-references: semantic markup and automatic links for functions, classes, glossary terms and similar pieces of information
Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children
Automatic indices: general index as well as a module index
Code highlighting: automatic highlighting using the Pygments highlighter
Templating: Flexible HTML output using the Jinja 2 templating engine
Extension ecosystem: Many extensions are available, for example for automatic function documentation or working with Jupyter notebooks.
Language Support: Python, C, C++, JavaScript, mathematics, and many other languages through extensions.

For more information, refer to the documentation.

Installation

The following command installs Sphinx from the Python Package Index. You will need a working installation of Python and pip.

pip install -U sphinx

Contributing

We appreciate all contributions! Refer to the contributors guide for information.

FAQs

What is Sphinx?

Python documentation generator. Visit Snyk Advisor to see a full health score report for Sphinx, including popularity, security, maintenance & community analysis.

Is Sphinx popular?

The python package Sphinx receives a total of 4,316,829 weekly downloads. As such, Sphinx popularity was classified as a key ecosystem project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is Sphinx well maintained?

We found indications that Sphinx maintenance is sustainable demonstrating some project activity. We saw a total of 430 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is Sphinx safe to use?

The python package Sphinx was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 20 December-2024, at 18: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

Sphinx

Python documentation generator For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Not sure how to use Sphinx?

Sphinx

Features

Installation

Contributing

FAQs

What is Sphinx?

Is Sphinx popular?

Is Sphinx well maintained?

Is Sphinx safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

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

Not sure how to use Sphinx?

Sphinx

Features

Installation

Contributing

FAQs

What is Sphinx?

Is Sphinx popular?

Is Sphinx well maintained?

Is Sphinx 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