Sphinx 扩展，用于构建 Atlassian Confluence 存储标记
项目描述
Atlassian Confluence Builder for Sphinx
Sphinx 扩展，用于构建与 Confluence® 兼容的标记格式文件，并可选择性将它们发布到 Confluence 实例。
要求
- Confluence 云或数据中心 7.19+
- Python 3.8+
- 请求 2.25.0+
- Sphinx 7.1+
安装
推荐使用 pip 来安装此扩展
pip install sphinxcontrib-confluencebuilder
(or)
python -m pip install sphinxcontrib-confluencebuilder
有关更详细的安装信息，请参阅
Atlassian Confluence Builder for Sphinx — 安装
https://sphinxcontrib-confluencebuilder.readthedocs.io/install
用法
- 在项目的配置脚本（
conf.py）中注册扩展sphinxcontrib.confluencebuilder
extensions = [
'sphinxcontrib.confluencebuilder',
]
- 使用构建器
confluence运行 sphinx-build
sphinx-build -b confluence . _build/confluence -E -a
(or)
python -m sphinx -b confluence . _build/confluence -E -a
有关此扩展用法的更多信息，请参阅
Atlassian Confluence Builder for Sphinx — 教程
https://sphinxcontrib-confluencebuilder.readthedocs.io/tutorial
配置
以下是一个用于生成和发布 Confluence 的简单配置示例
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
有关配置选项的完整列表，请参阅
Atlassian Confluence Builder for Sphinx — 配置
https://sphinxcontrib-confluencebuilder.readthedocs.io/configuration
特性
有关支持的标记、扩展等的完整列表，请参阅
Atlassian Confluence Builder for Sphinx — 特性
https://sphinxcontrib-confluencebuilder.readthedocs.io/features
有关此扩展支持的指令的完整列表，请参阅
Atlassian Confluence Builder for Sphinx — 指令
https://sphinxcontrib-confluencebuilder.readthedocs.io/directives
演示
通过检查这里发布的验证/测试文档可以查看此扩展的演示
Atlassian Confluence Builder for Sphinx — 在 Confluence 云上的在线演示
https://sphinxcontrib-confluencebuilder.atlassian.net/
Atlassian Confluence Builder for Sphinx 项目与 Atlassian 无关。
Atlassian 是 Atlassian Pty Ltd 的注册商标。
Confluence 是 Atlassian Pty Ltd 的注册商标。
项目详情
sphinxcontrib_confluencebuilder-2.7.1.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 4e3f66d1370f920f85216c188b16a1a68c76ed89fed2d5cfa69c1be44c26064d |
|
| MD5 | 2196713bb9112e0ce564093366e38108 |
|
| BLAKE2b-256 | 9b5bbe6a522def08ed38b4ab29ea579c9a1ba7b7914dd129bdc3781e35dfe85e |
sphinxcontrib_confluencebuilder-2.7.1-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 9a6ff7e3b892687eefdfc3d3c7fbeac765da14870bdd05b48a3143de869f83dc |
|
| MD5 | e2bc0659656dd88a90e2a41bd00a9e69 |
|
| BLAKE2b-256 | 2f918db782b4b0eb1a58a2579826caa1fce336d393cd93b13a95ede23e37a7fc |