斯芬克斯的阿特拉斯汇流延伸
sphinx-confluence的Python项目详细描述
Sphinx汇流插件
Sphinx扩展，用于使文档与 Confluence Storage Format。
功能：
- 基本HTML元素
- 图像（图像、图形）
- 代码块（：：）和包含（文字包含）
- 引用可下载文件（：download:）
- 目录树（…目录树：）
- 内部链接（：ref:<label>；…_）
- 内联和表JIRA问题
- 合流用户参考
- INFO、TIP、NOTE和WARNING宏
为什么？
此扩展是作为我们的文档工具包的一部分编写的，我们 日常工作中使用。工具包的主要思想是 可以自动创建和更新文档
我们工具包的其他部分是：
安装
从安装Sphinx汇流插件 PyPI使用
$ pip install sphinx-confluence
如何使用它
首先，在安装之后，必须在 build configuration fileconf.py，方法是将sphinx_confluence添加到extensions列表中。 看起来应该是a:
... extensions = ['sphinx_confluence'] ...
然后您可以将文档构建成html或json格式， 或者使用sphinx build command 或者如果通过以下命令使用sphinx-quickstart脚本： make html-make singlehtml-make json
之后，结果必须是合流存储格式。你可以 使用 confluence-publisher 把它们发布到你的合流处。
附加标记结构
sphinx合流插件向标准rest添加了一些新指令 加价。
JIRA问题
inline
Lorem ipsum dolor sit amet, :jira_issue:`PROJECT-123` consectetur adipiscing elit
表视图
标记：
..jira_issues::<JQL query>:anonymous:'true'|'false' (default: 'false'):server_id:'string' (default: ''):baseurl:'string' (default: ''):columns:A list of JIRA column names, separated by semi-colons (;):count:'true'|'false' (default: 'false'):height:int (default: 480):title:'string' (default: ''):render_mode:'static'|'dynamic' (default: 'static'):url:'string' (default: ''):width:'{x}px' | '{x}%' (default: '100%'):maximum_issues:int (default: 20)
示例：
..jira_issues:: project = PROJ AND issuetype = Epic AND resolution = Unresolved :title:Unresolved project epics:columns:type;key;summary;status;created;:width:80%
JIRA用户
Lorem ipsum dolor sit amet, :jira_user:`username` consectetur adipiscing elit
欢迎加入QQ群-->： 979659372
