sphinxcontrib-confluencebuilder

v2.9.0

Sphinx extension to build Atlassian Confluence Storage Markup For more information about how to use this package see README

Latest version published 1 month ago

License: BSD-2-Clause

PyPI

GitHub

Package Health Score

84 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Active

Explore Similar Packages

confluence
39

Popularity

Recognized

GitHub Stars: 320
Forks: 98
Contributors: 40

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package sphinxcontrib-confluencebuilder, we found that it has been starred 320 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Nov 11, 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 sphinxcontrib-confluencebuilder 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: 5
Open PR: 0
Last Release: 1 month ago
Last Commit: 18 days ago

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

We found that sphinxcontrib-confluencebuilder 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: 40
Funding: No

With more than 10 contributors for the sphinxcontrib-confluencebuilder 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: 8 years
Latest Release: 1 month ago
Dependencies: 0 Direct
Versions: 37
Maintainers: 0
Wheels: OS Independent

Readme

Atlassian Confluence Builder for Sphinx

Sphinx extension to build Confluence® compatible markup format files and optionally publish them to a Confluence instance.

Requirements

Confluence Cloud or Data Center 7.19+
Python 3.9+
Requests 2.25.0+
Sphinx 7.2+

Installing

The recommended method to installing this extension is using pip:

pip install sphinxcontrib-confluencebuilder
    (or)
python -m pip install sphinxcontrib-confluencebuilder

For a more in-depth installation information, see also:

Atlassian Confluence Builder for Sphinx — Installation
https://sphinxcontrib-confluencebuilder.readthedocs.io/install

Usage

extensions = [
   'sphinxcontrib.confluencebuilder',
]

Run sphinx-build with the builder confluence:

sphinx-build -b confluence . _build/confluence -E -a
 (or)
python -m sphinx -b confluence . _build/confluence -E -a

For more information on the usage of this extension, see also:

Atlassian Confluence Builder for Sphinx — Tutorial
https://sphinxcontrib-confluencebuilder.readthedocs.io/tutorial

Configuration

The following is an example of a simple configuration for Confluence generation and publishing:

extensions = [
   'sphinxcontrib.confluencebuilder',
]
confluence_publish = True
confluence_space_key = 'TEST'
confluence_parent_page = 'Documentation'
confluence_server_url = 'https://intranet-wiki.example.com/'
confluence_ask_user = True
confluence_ask_password = True

For a complete list of configuration options, see also:

Atlassian Confluence Builder for Sphinx — Configuration
https://sphinxcontrib-confluencebuilder.readthedocs.io/configuration

Features

For a complete list of supported markup, extensions, etc.; see:

Atlassian Confluence Builder for Sphinx — Features
https://sphinxcontrib-confluencebuilder.readthedocs.io/features

For a complete list of directives supported by this extension, see:

Atlassian Confluence Builder for Sphinx — Directives
https://sphinxcontrib-confluencebuilder.readthedocs.io/directives

Demonstration

A demonstration of this extension can be seen by inspecting the published validation/testing documents found here:

Atlassian Confluence Builder for Sphinx — Online Demo on Confluence Cloud
https://sphinxcontrib-confluencebuilder.atlassian.net/

Atlassian Confluence Builder for Sphinx project is unaffiliated with Atlassian.
Atlassian is a registered trademark of Atlassian Pty Ltd.
Confluence is a registered trademark of Atlassian Pty Ltd.

FAQs

What is sphinxcontrib-confluencebuilder?

Sphinx extension to build Atlassian Confluence Storage Markup. Visit Snyk Advisor to see a full health score report for sphinxcontrib-confluencebuilder, including popularity, security, maintenance & community analysis.

Is sphinxcontrib-confluencebuilder popular?

The python package sphinxcontrib-confluencebuilder receives a total of 52,969 weekly downloads. As such, sphinxcontrib-confluencebuilder popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is sphinxcontrib-confluencebuilder well maintained?

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

Is sphinxcontrib-confluencebuilder safe to use?

The python package sphinxcontrib-confluencebuilder 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 22 December-2024, at 18:41 (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