将Sphinx文档无缝集成到Confluence:Atlassian Confluence Builder for Sphinx
项目介绍
Atlassian Confluence Builder for Sphinx 是一个强大的Sphinx扩展,旨在将Sphinx生成的文档转换为Confluence兼容的标记格式,并可选择性地将这些文档发布到Confluence实例中。无论您是使用Confluence Cloud还是Data Center,这个扩展都能帮助您轻松地将技术文档集成到Confluence中,实现文档的统一管理和共享。
项目技术分析
技术栈
- Confluence:支持Confluence Cloud和Data Center 7.19+版本。
- Python:需要Python 3.8及以上版本。
- Requests:依赖于Requests库,版本需2.25.0及以上。
- Sphinx:需要Sphinx 7.1及以上版本。
安装与使用
通过pip
安装该扩展:
pip install sphinxcontrib-confluencebuilder
在Sphinx项目的conf.py
中注册该扩展:
extensions = [
'sphinxcontrib.confluencebuilder',
]
使用confluence
构建器生成文档:
sphinx-build -b confluence . _build/confluence -E -a
配置
通过简单的配置,您可以指定文档发布的目标Confluence空间、父页面等信息:
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
项目及技术应用场景
应用场景
- 技术文档管理:开发团队可以使用Sphinx生成技术文档,并通过该扩展将文档发布到Confluence,实现文档的集中管理和版本控制。
- 知识库构建:企业可以将内部知识库通过Sphinx生成,并自动同步到Confluence,方便员工查阅和更新。
- 项目文档共享:项目团队可以将项目文档通过Sphinx生成,并发布到Confluence,方便团队成员协作和共享。
项目特点
主要特点
- 无缝集成:支持将Sphinx生成的文档直接转换为Confluence兼容的格式,并发布到Confluence实例中。
- 灵活配置:提供丰富的配置选项,支持自定义文档发布的目标空间、父页面等信息。
- 广泛兼容:支持Confluence Cloud和Data Center,满足不同用户的需求。
- 易于使用:安装简单,配置灵活,使用方便,适合各种技术水平的用户。
功能亮点
- 支持多种标记格式:支持Sphinx中的多种标记格式,并将其转换为Confluence兼容的格式。
- 自动发布:支持自动将生成的文档发布到Confluence,减少手动操作的繁琐。
- 在线演示:提供在线演示,用户可以直观地了解该扩展的功能和效果。
结语
Atlassian Confluence Builder for Sphinx 是一个功能强大且易于使用的Sphinx扩展,能够帮助您将Sphinx生成的文档无缝集成到Confluence中。无论您是开发团队、企业还是项目团队,这个扩展都能为您提供便捷的文档管理和共享解决方案。立即尝试,体验文档管理的全新方式!