Package Health Score

66 / 100

security
Security review needed
popularity
Limited
maintenance
Sustainable
community
Active

Popularity

Limited

GitHub Stars: 156
Forks: 69
Contributors: 20

Direct Usage Popularity

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

Security

Security review needed

Security and license risk for latest version

Release Date: Aug 2, 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
1
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-multiversion-scylla 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: 35
Open PR: 10
Last Release: 5 months ago
Last Commit: 6 days ago

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

We found that sphinx-multiversion-scylla demonstrates a positive version release cadence with at least one new version released in the past 12 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: No
Code of Conduct: Yes
Contributors: 20
Funding: No

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

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.6.*, ==3.7.*

Age: 4 years
Latest Release: 5 months ago
Dependencies: 0 Direct
Versions: 21
Maintainers: 0
Wheels: No

Readme

sphinx-multiversion

Fork of https://github.com/Holzhaus/sphinx-multiversion for the ScyllaDB Project.

Sphinx extension for building self-hosted versioned docs.

Original documentation can be found at: https://holzhaus.github.io/sphinx-multiversion/

Fork additions

Prebuild and postbuild commands

The fork introduces the possibility to run custom commands before and after building the docs with the option --pre-build and --post-build.

This could be useful to prepare the docs repository before running sphinx-build, debug the execution, or even generate versioned documentation using other builders.

For example, imagine that you want to build versioned docs written in Sphinx, but the API reference is generated with JavaDoc. This option enables the generation of both versioned docs to host them under the same folder using GitHub Pages.

Here's an example showing the directory where the build command is running:

sphinx-multiversion docs build/html --pre-build pw

You can pass multiple commands by adding extra --pre-build or --post-build options. The commands run in order, from left to right:

sphinx-multiversion docs build/html --pre-build pwd --pre-build ls --post-build "cat file.txt"

Rename latest version URL

The smv_latest_version setting determines which is the latest version. Setting this option could be useful to show a warning when users are not reading the latest version.

You can override the latest version output directory with smv_rename_latest_version.

Here's an example:

smv_latest_version = 'x.y.z'         # Use the branch/tag name
smv_rename_latest_version = 'latest' # Use the commit hash

Version specific overrides

The following properties can be defined on a per-version basis.

rst_prolog
exclude_patterns: Introduced in 0.3.2

License

BSD 2-Clause License

Modifications (see "Fork Additions") 2020, David Garcia

FAQs

What is sphinx-multiversion-scylla?

Add support for multiple versions to sphinx. Visit Snyk Advisor to see a full health score report for sphinx-multiversion-scylla, including popularity, security, maintenance & community analysis.

Is sphinx-multiversion-scylla popular?

The python package sphinx-multiversion-scylla receives a total of 489 weekly downloads. As such, sphinx-multiversion-scylla popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is sphinx-multiversion-scylla well maintained?

We found indications that sphinx-multiversion-scylla maintenance is sustainable demonstrating some project activity. We saw a total 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-multiversion-scylla safe to use?

While scanning the latest version of sphinx-multiversion-scylla, 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 21 December-2024, at 12:56 (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-multiversion-scylla

Add support for multiple versions to sphinx For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

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

Readme

sphinx-multiversion

Fork additions

Prebuild and postbuild commands

Rename latest version URL

Add support for custom tags

Fix Git LFS error

Enable paralell builds

Version specific overrides

License

FAQs

What is sphinx-multiversion-scylla?

Is sphinx-multiversion-scylla popular?

Is sphinx-multiversion-scylla well maintained?

Is sphinx-multiversion-scylla 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

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-multiversion

Fork additions

Prebuild and postbuild commands

Rename latest version URL

Add support for custom tags

Fix Git LFS error

Enable paralell builds

Version specific overrides

License

FAQs

What is sphinx-multiversion-scylla?

Is sphinx-multiversion-scylla popular?

Is sphinx-multiversion-scylla well maintained?

Is sphinx-multiversion-scylla 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