| Name | sphinx-confluencebuilder-bridge JSON |
| Version |
2025.11.16
JSON |
| download |
| home_page | None |
| Summary | Extension for Sphinx which enables using directives and roles from Atlassian® Confluence® Builder for Sphinx in other Sphinx builders such as HTML. |
| upload_time | 2025-11-16 07:16:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
confluence
documentation
rst
sphinx
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
|Build Status| |PyPI|
Sphinx Confluence Builder Bridge
================================
Extension for Sphinx which enables using directives and roles from `Atlassian® Confluence® Builder for Sphinx <https://sphinxcontrib-confluencebuilder.readthedocs.io>`_ in other Sphinx builders such as HTML.
This enables you to use HTML builds for easy iteration while developing documentation which is primarily meant for Confluence.
.. contents::
Installation
------------
``sphinx-confluencebuilder-bridge`` is compatible with Python |minimum-python-version|\+.
.. code-block:: console
$ pip install sphinx-confluencebuilder-bridge
Setup
-----
Add the following to ``conf.py`` to enable the extension:
.. code-block:: python
"""Configuration for Sphinx."""
extensions = ["sphinxcontrib.confluencebuilder"] # Example existing extensions
extensions += [
# This must come after ``"sphinxcontrib.confluencebuilder"``
"sphinx_confluencebuilder_bridge"
]
Supported directives
--------------------
Only some of the `directives supported by Atlassian® Confluence® Builder for Sphinx <https://sphinxcontrib-confluencebuilder.readthedocs.io/directives>`_ are supported.
The following directives are supported:
* `confluence_toc <https://sphinxcontrib-confluencebuilder.readthedocs.io/en/stable/directives/#directive-confluence_toc>`_
* The only supported option is `max-level <https://sphinxcontrib-confluencebuilder.readthedocs.io/en/stable/directives/#directive-option-confluence_toc-max-level>`_.
* ``confluence_viewpdf``
* HTML builder only.
* Requires the PDF to be in a directory specified in `html_static_path <https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_static_path>`_.
Supported roles
---------------
Only some of the `roles supported by Atlassian® Confluence® Builder for Sphinx <https://sphinxcontrib-confluencebuilder.readthedocs.io/roles>`_ are supported.
The following roles are supported:
* `confluence_link <https://sphinxcontrib-confluencebuilder.readthedocs.io/en/stable/roles/#role-confluence_link>`_
* This renders as a normal hyperlink, unlike in Confluence where the page title is shown.
* `confluence_doc <https://sphinxcontrib-confluencebuilder.readthedocs.io/en/stable/roles/#role-confluence_doc>`_
* This renders as a normal documentation link, unlike in Confluence where the page title is shown.
* `confluence_mention <https://sphinxcontrib-confluencebuilder.readthedocs.io/en/stable/roles/#role-confluence_mention>`_
* This renders as a link with the text being the user's account identifier, user key or username.
* For this to show a clear account identifier, set `confluence_mentions <https://sphinxcontrib-confluencebuilder.readthedocs.io/en/stable/configuration/#confval-confluence_mentions>`_ in ``conf.py``.
Contributing
------------
See `CONTRIBUTING.rst <./CONTRIBUTING.rst>`_.
.. |Build Status| image:: https://github.com/adamtheturtle/sphinx-confluencebuilder-bridge/actions/workflows/ci.yml/badge.svg?branch=main
:target: https://github.com/adamtheturtle/sphinx-confluencebuilder-bridge/actions
.. |PyPI| image:: https://badge.fury.io/py/sphinx-confluencebuilder-bridge.svg
:target: https://badge.fury.io/py/sphinx-confluencebuilder-bridge
.. |minimum-python-version| replace:: 3.11
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-confluencebuilder-bridge",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "confluence, documentation, rst, sphinx",
"author": null,
"author_email": "Adam Dangoor <adamdangoor@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4b/4b/c99ab3ee9b4471d5461b4f4e8fbd843d4f7d6a5c91a9433d7c88938d6c58/sphinx_confluencebuilder_bridge-2025.11.16.tar.gz",
"platform": null,
"description": "|Build Status| |PyPI|\n\nSphinx Confluence Builder Bridge\n================================\n\nExtension for Sphinx which enables using directives and roles from `Atlassian\u00ae Confluence\u00ae Builder for Sphinx <https://sphinxcontrib-confluencebuilder.readthedocs.io>`_ in other Sphinx builders such as HTML.\nThis enables you to use HTML builds for easy iteration while developing documentation which is primarily meant for Confluence.\n\n.. contents::\n\nInstallation\n------------\n\n``sphinx-confluencebuilder-bridge`` is compatible with Python |minimum-python-version|\\+.\n\n.. code-block:: console\n\n $ pip install sphinx-confluencebuilder-bridge\n\nSetup\n-----\n\nAdd the following to ``conf.py`` to enable the extension:\n\n.. code-block:: python\n\n \"\"\"Configuration for Sphinx.\"\"\"\n\n extensions = [\"sphinxcontrib.confluencebuilder\"] # Example existing extensions\n\n extensions += [\n # This must come after ``\"sphinxcontrib.confluencebuilder\"``\n \"sphinx_confluencebuilder_bridge\"\n ]\n\nSupported directives\n--------------------\n\nOnly some of the `directives supported by Atlassian\u00ae Confluence\u00ae Builder for Sphinx <https://sphinxcontrib-confluencebuilder.readthedocs.io/directives>`_ are supported.\nThe following directives are supported:\n\n* `confluence_toc <https://sphinxcontrib-confluencebuilder.readthedocs.io/en/stable/directives/#directive-confluence_toc>`_\n * The only supported option is `max-level <https://sphinxcontrib-confluencebuilder.readthedocs.io/en/stable/directives/#directive-option-confluence_toc-max-level>`_.\n\n* ``confluence_viewpdf``\n * HTML builder only.\n * Requires the PDF to be in a directory specified in `html_static_path <https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_static_path>`_.\n\nSupported roles\n---------------\n\nOnly some of the `roles supported by Atlassian\u00ae Confluence\u00ae Builder for Sphinx <https://sphinxcontrib-confluencebuilder.readthedocs.io/roles>`_ are supported.\nThe following roles are supported:\n\n* `confluence_link <https://sphinxcontrib-confluencebuilder.readthedocs.io/en/stable/roles/#role-confluence_link>`_\n * This renders as a normal hyperlink, unlike in Confluence where the page title is shown.\n* `confluence_doc <https://sphinxcontrib-confluencebuilder.readthedocs.io/en/stable/roles/#role-confluence_doc>`_\n * This renders as a normal documentation link, unlike in Confluence where the page title is shown.\n* `confluence_mention <https://sphinxcontrib-confluencebuilder.readthedocs.io/en/stable/roles/#role-confluence_mention>`_\n * This renders as a link with the text being the user's account identifier, user key or username.\n * For this to show a clear account identifier, set `confluence_mentions <https://sphinxcontrib-confluencebuilder.readthedocs.io/en/stable/configuration/#confval-confluence_mentions>`_ in ``conf.py``.\n\nContributing\n------------\n\nSee `CONTRIBUTING.rst <./CONTRIBUTING.rst>`_.\n\n.. |Build Status| image:: https://github.com/adamtheturtle/sphinx-confluencebuilder-bridge/actions/workflows/ci.yml/badge.svg?branch=main\n :target: https://github.com/adamtheturtle/sphinx-confluencebuilder-bridge/actions\n.. |PyPI| image:: https://badge.fury.io/py/sphinx-confluencebuilder-bridge.svg\n :target: https://badge.fury.io/py/sphinx-confluencebuilder-bridge\n.. |minimum-python-version| replace:: 3.11\n",
"bugtrack_url": null,
"license": null,
"summary": "Extension for Sphinx which enables using directives and roles from Atlassian\u00ae Confluence\u00ae Builder for Sphinx in other Sphinx builders such as HTML.",
"version": "2025.11.16",
"project_urls": {
"Source": "https://github.com/adamtheturtle/sphinx-confluencebuilder-bridge"
},
"split_keywords": [
"confluence",
" documentation",
" rst",
" sphinx"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "aea4b229b893cc2a473dff99ad7cf878a87e8017476a2ecee5f268159b7e51d6",
"md5": "89a12eecb9bf24f710a2f1cda6f9af10",
"sha256": "6519906feb91c419a5c112b50e8c454ccbb654a25e13d10d9b14bb86c79edb18"
},
"downloads": -1,
"filename": "sphinx_confluencebuilder_bridge-2025.11.16-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "89a12eecb9bf24f710a2f1cda6f9af10",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.11",
"size": 6602,
"upload_time": "2025-11-16T07:16:35",
"upload_time_iso_8601": "2025-11-16T07:16:35.748965Z",
"url": "https://files.pythonhosted.org/packages/ae/a4/b229b893cc2a473dff99ad7cf878a87e8017476a2ecee5f268159b7e51d6/sphinx_confluencebuilder_bridge-2025.11.16-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4b4bc99ab3ee9b4471d5461b4f4e8fbd843d4f7d6a5c91a9433d7c88938d6c58",
"md5": "aff0c5528720782e17bafddc0974135e",
"sha256": "2a1b778edd11ba770a5895280748ec84fd63ae2a4bae374fb87aa0fc1d596b64"
},
"downloads": -1,
"filename": "sphinx_confluencebuilder_bridge-2025.11.16.tar.gz",
"has_sig": false,
"md5_digest": "aff0c5528720782e17bafddc0974135e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 391583,
"upload_time": "2025-11-16T07:16:37",
"upload_time_iso_8601": "2025-11-16T07:16:37.284089Z",
"url": "https://files.pythonhosted.org/packages/4b/4b/c99ab3ee9b4471d5461b4f4e8fbd843d4f7d6a5c91a9433d7c88938d6c58/sphinx_confluencebuilder_bridge-2025.11.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-16 07:16:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adamtheturtle",
"github_project": "sphinx-confluencebuilder-bridge",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-confluencebuilder-bridge"
}
