sphinxcontrib-confluencebuilder 1.1.0

要求

• Python2.7或3.4+
• Requests2.14.0+
• Sphinx1.6.3+

如果发布：

• Confluence云或服务器6.1+

安装

安装此扩展的建议方法是使用pip：

pip install sphinxcontrib-confluencebuilder

有关更深入的安装信息，请参见：

Atlassian Confluence Builder for Sphinx - Installation

https://sphinxcontrib-confluencebuilder.readthedocs.io/en/latest/install.html

用法

• 将中的生成器sphinxcontrib.confluencebuilder设置为中的扩展 conf.py：

extensions=['sphinxcontrib.confluencebuilder']

• 使用生成器运行sphinx build confluence：

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

有关此扩展的用法的详细信息，请参见：

Atlassian Confluence Builder for Sphinx - Tutorial

https://sphinxcontrib-confluencebuilder.readthedocs.io/en/latest/tutorial.html

配置

下面是汇流生成的简单配置示例 出版：

extensions=['sphinxcontrib.confluencebuilder']confluence_publish=Trueconfluence_space_name='TEST'confluence_parent_page='Documentation'confluence_server_url='https://intranet-wiki.example.com'confluence_server_user='username'confluence_server_pass='password'

有关配置更改的完整列表，另请参见：

Atlassian Confluence Builder for Sphinx - Configuration

https://sphinxcontrib-confluencebuilder.readthedocs.io/en/latest/configuration.html

演示

可以找到一组用于帮助验证/测试的示例文档 这里：

Atlassian Confluence Builder for Sphinx - Validation Set

https://github.com/sphinx-contrib/confluencebuilder/tree/master/test/validation-sets

可以找到已发布验证文档的活动版本和旧版本 这里：

Atlassian Confluence Builder for Sphinx - Online Demo on Confluence Cloud

https://jdknight.atlassian.net/wiki/spaces/confluencebuilder/

支持的标记

有关支持的标记的完整列表，请参阅以下内容：

Atlassian Confluence Builder for Sphinx - Markup

https://sphinxcontrib-confluencebuilder.readthedocs.io/en/latest/markup.html