sphinx-book-theme

v1.1.3

A clean book theme for scientific explanations and documentation with Sphinx For more information about how to use this package see README

Latest version published 5 months ago

License: BSD-3-Clause

PyPI

GitHub

Package Health Score

87 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Active

Popularity

Popular

GitHub Stars: 439
Forks: 201
Contributors: 70

Direct Usage Popularity

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

Security

No known security issues

Security and license risk for latest version

Release Date: Jun 12, 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-3-Clause

Security Policy

We found a way for you to contribute to the project! Looks like sphinx-book-theme 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: 91
Open PR: 18
Last Release: 5 months ago
Last Commit: 23 days ago

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

We found that sphinx-book-theme 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: Yes
Code of Conduct: Yes
Contributors: 70
Funding: No

With more than 10 contributors for the sphinx-book-theme 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.9

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

Readme

sphinx-book-theme

An interactive book theme for Sphinx.

This is a lightweight Sphinx theme designed to mimic the look-and-feel of an interactive book. It has the following primary features:

Bootstrap 5 for visual elements and functionality.
Flexible content layout that is inspired by beautiful online books, such as the Edward Tufte CSS guide
Visual classes designed for Jupyter Notebooks. Cell inputs, outputs, and interactive functionality are all supported.
Launch buttons for online interactivity. For pages that are built with computational material, connect your site to an online BinderHub for interactive content.

Get started

To get started with sphinx-book-theme, first install it with pip:

pip install sphinx-book-theme

then, activate the theme in your Sphinx configuration (conf.py):

...
html_theme = "sphinx_book_theme"
...

This will activate the Sphinx Book Theme for your documentation. Note that you may need to change your html_theme_options configuration depending on your previous theme. See the pages to the left for information about what you can configure with sphinx-book-theme.

Documentation

See the Sphinx Book Theme documentation for more information.

FAQs

What is sphinx-book-theme?

A clean book theme for scientific explanations and documentation with Sphinx. Visit Snyk Advisor to see a full health score report for sphinx-book-theme, including popularity, security, maintenance & community analysis.

Is sphinx-book-theme popular?

The python package sphinx-book-theme receives a total of 129,149 weekly downloads. As such, sphinx-book-theme popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is sphinx-book-theme well maintained?

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

Is sphinx-book-theme safe to use?

The python package sphinx-book-theme 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 21 November-2024, at 08:51 (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

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-book-theme

Get started

Documentation

FAQs

What is sphinx-book-theme?

Is sphinx-book-theme popular?

Is sphinx-book-theme well maintained?

Is sphinx-book-theme 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