用于将sphinx生成的文档发布到合流的工具
confluence-publisher-ex的Python项目详细描述
#Confluence publisher
一个帮助将文档发布到Confluence的工具。
此工具使用自己的配置文件。
这些工具是作为我们日常工作中使用的文档工具包的一部分编写的。
工具包的主要思想是使创建和更新文档的过程能够自动进行
有了
`````
```
````
`
`
```
`````
`````
` ` ` ` `
` `
` ` `
` ` ` `
` ` ` `
` ` ` ` ` ` ` ` ` ` ` `
` ` ` ` ` ` `
` ` ` ` ` ` ` ` ` ` ` ` ` `
`br/>用法:conf_publisher[-h][-uurl](-a auth-u用户)[-f][-w水印]
[-l链接][-ht][-v][-ac][-fo]
config
发布文档(sphinx fjson)以合并
positional参数:
config配置文件
可选参数:
-h,-帮助显示此帮助消息并退出
U-URL,-URL URL汇合URL< BR/> -AUTH,-AuthAuthBase64编码用户:密码字符串
U用户,用户用户用户名(提示密码)
-F,强制发布未更改页面。水印。也可以是“false”以删除所有水印;或者是“true”以添加带有默认文本“自动生成的内容”的水印。不要在所有页面上直接编辑。如果值为“false”,则删除
链接。
-HT,在发布时保持标题不改变页面标题。
-V,-VBBOSE
-AC,在不存在时自动创建自动创建页。在配置文件中。
```
配置文件格式
指令:
-**版本**(必需)配置版本。当前为``2`.
-**url**(必需)基汇合url.
-**base_dir**(必需)包含要发布的json的目录。
-**downloads_dir**(可选)默认为_downloads
-**images_dir**(可选)默认为_images
-**source_ext**(可选)默认为.fjson
-**space key**(必需)空格键**应该创建文档的地方。
*PARETEXPAGE **(需要)一个页面ID,它应该是文档的根节点。
**Page **(所需)页面将被发布。
BR/> -**ID**(可选带有-AC标志)合流页面ID。如果页面不存在,使用`` conf_page_maker``创建它。
-**title**(可选)
-**source**(必需)与水印下的页面
-**link**(可选)链接关联的json路径(例如到repo中的源rst)。
-**watermark**(可选)水印放在页面上。例如:“自动生成的内容。不要直接编辑“.
-**要附加的附件**(可选)文件。
-**图像**
-路径到IMG1
-路径到IMG2
-**下载**
-路径到文件1
-路径到文件2
-**要发布的页**子页。
-**页面的结构
\:入门/索引
页面:
-标题:“架构”
来源:入门/架构
附件:
图像:
-第一个arch.png
-第二个arch.png
-标题:“编写第一个应用程序”
来源:入门/编写第一个应用程序
附件:
下载:
-sample1.properties
-sample2.properties
````
一个帮助将文档发布到Confluence的工具。
此工具使用自己的配置文件。
这些工具是作为我们日常工作中使用的文档工具包的一部分编写的。
工具包的主要思想是使创建和更新文档的过程能够自动进行
有了
`````
```
````
`
`
```
`````
`````
` ` ` ` `
` `
` ` `
` ` ` `
` ` ` `
` ` ` ` ` ` ` ` ` ` ` `
` ` ` ` ` ` `
` ` ` ` ` ` ` ` ` ` ` ` ` `
`br/>用法:conf_publisher[-h][-uurl](-a auth-u用户)[-f][-w水印]
[-l链接][-ht][-v][-ac][-fo]
config
发布文档(sphinx fjson)以合并
positional参数:
config配置文件
可选参数:
-h,-帮助显示此帮助消息并退出
U-URL,-URL URL汇合URL< BR/> -AUTH,-AuthAuthBase64编码用户:密码字符串
U用户,用户用户用户名(提示密码)
-F,强制发布未更改页面。水印。也可以是“false”以删除所有水印;或者是“true”以添加带有默认文本“自动生成的内容”的水印。不要在所有页面上直接编辑。如果值为“false”,则删除
链接。
-HT,在发布时保持标题不改变页面标题。
-V,-VBBOSE
-AC,在不存在时自动创建自动创建页。在配置文件中。
```
配置文件格式
指令:
-**版本**(必需)配置版本。当前为``2`.
-**url**(必需)基汇合url.
-**base_dir**(必需)包含要发布的json的目录。
-**downloads_dir**(可选)默认为_downloads
-**images_dir**(可选)默认为_images
-**source_ext**(可选)默认为.fjson
-**space key**(必需)空格键**应该创建文档的地方。
*PARETEXPAGE **(需要)一个页面ID,它应该是文档的根节点。
**Page **(所需)页面将被发布。
BR/> -**ID**(可选带有-AC标志)合流页面ID。如果页面不存在,使用`` conf_page_maker``创建它。
-**title**(可选)
-**source**(必需)与水印下的页面
-**link**(可选)链接关联的json路径(例如到repo中的源rst)。
-**watermark**(可选)水印放在页面上。例如:“自动生成的内容。不要直接编辑“.
-**要附加的附件**(可选)文件。
-**图像**
-路径到IMG1
-路径到IMG2
-**下载**
-路径到文件1
-路径到文件2
-**要发布的页**子页。
-**页面的结构
\:入门/索引
页面:
-标题:“架构”
来源:入门/架构
附件:
图像:
-第一个arch.png
-第二个arch.png
-标题:“编写第一个应用程序”
来源:入门/编写第一个应用程序
附件:
下载:
-sample1.properties
-sample2.properties
````