Package Health Score

76 / 100

security
Security review needed
popularity
Recognized
maintenance
Healthy
community
Active

Popularity

Recognized

GitHub Stars: 40
Forks: 16
Contributors: 20

Direct Usage Popularity

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

Security

Security review needed

Security and license risk for latest version

Release Date: Sep 3, 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

MIT

Security Policy

We found a way for you to contribute to the project! Looks like sphinx-markdown-builder 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: 10
Open PR: 1
Last Release: 3 months ago
Last Commit: 3 months ago

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

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

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Active

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

With more than 10 contributors for the sphinx-markdown-builder 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.7

Age: 6 years
Latest Release: 3 months ago
Dependencies: 2 Direct / 26 Total
Versions: 31
Maintainers: 2
Wheels: OS Independent

Readme

sphinx-markdown-builder

A Sphinx extension to add markdown generation support.

Install

pip3 install sphinx-markdown-builder==0.6.7

Usage

Add the extension to your conf.py file:

extensions = [
    ...,
    "sphinx_markdown_builder",
    ...,
]

Build markdown files with sphinx-build command

sphinx-build -M markdown ./docs ./build

Configurations

You can add the following configurations to your conf.py file:

markdown_anchor_sections/markdown_anchor_signatures: If set to True, then anchors will be added before each section/function/class signature. This allows references to a specific anchor in the document.
markdown_docinfo: Adds metadata to the top of each document containing author, copyright, and version.
markdown_http_base: If set, all references will link to this prefix address
markdown_uri_doc_suffix: If set, all references will link to documents with this suffix.

For example, if your conf.py file have the following configuration:

markdown_http_base = "https://your-domain.com/docs"
markdown_uri_doc_suffix = ".html"

Then a reference to your-doc-name#your-header will be substituted with https://your-domain.com/docs/your-doc-name.html#your-header.

Contributing

See the code contribution guidelines for more information.

Credits

This project forked from clayrisser/sphinx-markdown-builder, which was developed by Clay Risser under the MIT license.

The original implementation was based on doctree2md by Matthew Brett under the BSD-2 license.

License

MIT

sphinx-markdown-builder dependencies

docutils tabulate

FAQs

What is sphinx-markdown-builder?

A Sphinx extension to add markdown generation support. Visit Snyk Advisor to see a full health score report for sphinx-markdown-builder, including popularity, security, maintenance & community analysis.

Is sphinx-markdown-builder popular?

The python package sphinx-markdown-builder receives a total of 20,144 weekly downloads. As such, sphinx-markdown-builder popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is sphinx-markdown-builder well maintained?

We found that sphinx-markdown-builder 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-markdown-builder safe to use?

While scanning the latest version of sphinx-markdown-builder, 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 22 November-2024, at 15:16 (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-markdown-builder

A Sphinx extension to add markdown generation support. 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-markdown-builder

Install

Usage

Configurations

Contributing

Credits

License

sphinx-markdown-builder dependencies

FAQs

What is sphinx-markdown-builder?

Is sphinx-markdown-builder popular?

Is sphinx-markdown-builder well maintained?

Is sphinx-markdown-builder 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-markdown-builder

Install

Usage

Configurations

Contributing

Credits

License

sphinx-markdown-builder dependencies

FAQs

What is sphinx-markdown-builder?

Is sphinx-markdown-builder popular?

Is sphinx-markdown-builder well maintained?

Is sphinx-markdown-builder 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