{"id":19931061,"url":"https://github.com/sphinx-contrib/confluencebuilder","last_synced_at":"2025-05-14T13:08:37.065Z","repository":{"id":34300590,"uuid":"62764493","full_name":"sphinx-contrib/confluencebuilder","owner":"sphinx-contrib","description":"Confluence Markup Builder Plugin for Sphinx","archived":false,"fork":false,"pushed_at":"2025-05-12T03:52:36.000Z","size":5684,"stargazers_count":331,"open_issues_count":11,"forks_count":98,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-05-12T04:34:52.428Z","etag":null,"topics":["documentation","python","sphinx","sphinx-extension"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sphinx-contrib.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.rst","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"support/docker/Dockerfile","governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-07-07T01:20:41.000Z","updated_at":"2025-05-12T03:52:39.000Z","dependencies_parsed_at":"2024-01-27T04:20:22.448Z","dependency_job_id":"e100f136-0647-454d-b3fe-b9ea1aca875d","html_url":"https://github.com/sphinx-contrib/confluencebuilder","commit_stats":{"total_commits":2589,"total_committers":37,"mean_commits":69.97297297297297,"dds":0.09385863267670913,"last_synced_commit":"b480a2b1aefb02f0535936c8af2e90b708398e83"},"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fconfluencebuilder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fconfluencebuilder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fconfluencebuilder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fconfluencebuilder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-contrib","download_url":"https://codeload.github.com/sphinx-contrib/confluencebuilder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253678844,"owners_count":21946314,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","python","sphinx","sphinx-extension"],"created_at":"2024-11-12T23:06:00.604Z","updated_at":"2025-05-14T13:08:32.045Z","avatar_url":"https://github.com/sphinx-contrib.png","language":"Python","readme":"# Atlassian Confluence Builder for Sphinx\n\n[![pip Version](https://badgen.net/pypi/v/sphinxcontrib-confluencebuilder?label=PyPI)](https://pypi.python.org/pypi/sphinxcontrib-confluencebuilder)\n[![Build Status](https://github.com/sphinx-contrib/confluencebuilder/actions/workflows/build.yml/badge.svg)](https://github.com/sphinx-contrib/confluencebuilder/actions/workflows/build.yml) \n[![Documentation Status](https://img.shields.io/readthedocs/sphinxcontrib-confluencebuilder?label=Documentation)](https://sphinxcontrib-confluencebuilder.readthedocs.io/) \n[![PyPI download month](https://img.shields.io/pypi/dm/sphinxcontrib-confluencebuilder.svg?label=Downloads)](https://pypi.python.org/pypi/sphinxcontrib-confluencebuilder/) \n\n[Sphinx][sphinx] extension to build Confluence® compatible markup format\nfiles and optionally publish them to a Confluence instance.\n\n## Requirements\n\n* [Confluence][confluence] Cloud or Data Center 8.1+\n* [Python][python] 3.9+\n* [Requests][requests] 2.25.0+\n* [Sphinx][sphinx] 7.3+\n\n## Installing\n\nThe recommended method to installing this extension is using [pip][pip]:\n\n```shell\npip install sphinxcontrib-confluencebuilder\n (or)\npython -m pip install sphinxcontrib-confluencebuilder\n```\n\nFor a more in-depth installation information, see also:\n\n\u003e Atlassian Confluence Builder for Sphinx — Installation \\\n\u003e https://sphinxcontrib-confluencebuilder.readthedocs.io/install\n\n## Usage\n\n- Register the extension `sphinxcontrib.confluencebuilder` in the project's\n  configuration script (`conf.py`):\n\n```python\nextensions = [\n    'sphinxcontrib.confluencebuilder',\n]\n```\n\n- Run sphinx-build with the builder `confluence`:\n\n```shell\nsphinx-build -M confluence . _build -E -a\n (or)\npython -m sphinx -M confluence . _build -E -a\n```\n\nFor more information on the usage of this extension, see also:\n\n\u003e Atlassian Confluence Builder for Sphinx — Tutorial \\\n\u003e https://sphinxcontrib-confluencebuilder.readthedocs.io/tutorial\n\n## Configuration\n\nThe following is an example of a simple configuration for Confluence generation\nand publishing:\n\n```python\nextensions = [\n    'sphinxcontrib.confluencebuilder',\n]\nconfluence_publish = True\nconfluence_space_key = 'TEST'\nconfluence_parent_page = 'Documentation'\nconfluence_server_url = 'https://intranet-wiki.example.com/'\nconfluence_ask_user = True\nconfluence_ask_password = True\n```\n\nFor a complete list of configuration options, see also:\n\n\u003e Atlassian Confluence Builder for Sphinx — Configuration \\\n\u003e https://sphinxcontrib-confluencebuilder.readthedocs.io/configuration\n\n## Features\n\nFor a complete list of supported markup, extensions, etc.; see:\n\n\u003e Atlassian Confluence Builder for Sphinx — Features \\\n\u003e https://sphinxcontrib-confluencebuilder.readthedocs.io/features\n\nFor a complete list of directives supported by this extension, see:\n\n\u003e Atlassian Confluence Builder for Sphinx — Directives \\\n\u003e https://sphinxcontrib-confluencebuilder.readthedocs.io/directives\n\n## Demonstration\n\nA demonstration of this extension can be seen by inspecting the published\nvalidation/testing documents found here:\n\n\u003e Atlassian Confluence Builder for Sphinx — Online Demo on Confluence Cloud \\\n\u003e https://sphinxcontrib-confluencebuilder.atlassian.net/\n\n----\n\nAtlassian Confluence Builder for Sphinx project is unaffiliated with Atlassian.\\\nAtlassian is a registered trademark of Atlassian Pty Ltd.\\\nConfluence is a registered trademark of Atlassian Pty Ltd.\n\n\n[confluence]: https://www.atlassian.com/software/confluence\n[pip]: https://pip.pypa.io/\n[python]: https://www.python.org/\n[requests]: https://pypi.python.org/pypi/requests\n[sphinx]: https://www.sphinx-doc.org/\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fconfluencebuilder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-contrib%2Fconfluencebuilder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fconfluencebuilder/lists"}