معرفی شرکت ها

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

توضیحات

Tool for publishing Sphinx generated documents to Confluence

ویژگی	مقدار
سیستم عامل	-
نام فایل	confluence-publisher-1.2.1
نام	confluence-publisher
نسخه کتابخانه	1.2.1
نگهدارنده	[]
ایمیل نگهدارنده	[]
نویسنده	Arello Mobile
ایمیل نویسنده	-
آدرس صفحه اصلی	https://github.com/Arello-Mobile/confluence-publisher
آدرس اینترنتی	https://pypi.org/project/confluence-publisher/
مجوز	MIT

Confluence Publisher ==================== |Build Status| Set of tools to help publish documentation to Confluence. It includes: - conf\_publisher - conf\_page\_maker - conf\_page\_dumper This tools use own configuration file. For now it supports: - confluence versions: 5.5 - 5.9 - sphinx-build formats: "fjson", "html" Why? ---- This tools are written as part of our Documentation Toolkit which we use in our job daily. The main idea of toolkit is to make a process of creating and updating documentation able to be automated Other parts of our toolkit is: - `py2swagger <https://github.com/Arello-Mobile/py2swagger>`__ - `swagger2rst <https://github.com/Arello-Mobile/swagger2rst>`__ - `sphinx-confluence <https://github.com/Arello-Mobile/sphinx-confluence>`__ - `confluence-publisher <https://github.com/Arello-Mobile/confluence-publisher>`__ Install ======= Install Confluence Publisher from `PyPI <https://pypi.python.org/pypi/confluence-publisher>`__ with :: $ pip install confluence-publisher Publisher --------- :: $ conf_publisher config.yml --auth XXXXXjpwYXNzdXXXXX== If a config doesn't contain page.id, you can use ``conf_page_maker`` command to create a page and page ID will be put into config automatically. :: usage: conf_publisher [-h] [-u URL] [-a AUTH] [-F] [-w WATERMARK] [-l LINK] [-ht] [-v] config Publish documentation (Sphinx fjson) to Confluence positional arguments: config Configuration file optional arguments: -h, --help show this help message and exit -u URL, --url URL Confluence Url -a AUTH, --auth AUTH Base64 encoded user:password string -F, --force Publish not changed page. -w WATERMARK, --watermark WATERMARK Overrides the watermarks. Also can be "False" to remove all watermarks; or "True" to add watermarkswith default text: "Automatically generated content. Do not edit directly." on all pages. -l LINK, --link LINK Overrides page link. If value is "False" then removes the link. -ht, --hold-titles Do not change page titles while publishing. -v, --verbose Page Maker ---------- :: $ conf_page_maker config.yml --auth XXXXXjpwYXNzdXXXXX== --parent-id 52332132 :: usage: conf_page_maker [-h] [-u URL] [-a AUTH] [-pid PARENT_ID] [-v] config Create Confluence pages and update configuration file with it ids positional arguments: config Configuration file optional arguments: -h, --help show this help message and exit -u URL, --url URL Confluence Url -a AUTH, --auth AUTH Base64 encoded user:password string. Required. -pid PARENT_ID, --parent-id PARENT_ID Parent page ID in confluence. -v, --verbose Page dumper ----------- :: usage: conf_page_dumper [-h] [-u URL] [-a AUTH] [-o OUTPUT] page_id Dumps Confluence page in storage format positional arguments: page_id Configuration file optional arguments: -h, --help show this help message and exit -u URL, --url URL Confluence Url -a AUTH, --auth AUTH Base64 encoded user:password string -o OUTPUT, --output OUTPUT Output file|stdout|stderr Configuration file format ------------------------- Directives: - **version** (required) Config version. Current is ``2``. - **url** (required) Base Confluence URL. - **base\_dir** (required) Directory containing json to be published. - **downloads\_dir** (optional) Default is \_downloads - **images\_dir** (optional) Default is \_images - **source\_ext** (optional) Default is .fjson - **pages** (required) Pages to be published. - **id** (required) Confluence page ID. If page does not exists, create it with ``conf_page_maker``. - **title** (optional) - **source** (required) Path to json associated with the page - **link** (optional) Link under watermark (for example to source rst in repo). - **watermark** (optional) Watermark to put on page. E.g.: "Automatically generated content. Do not edit directly"". - **attachments** (optional) Files to be attached. - **images** - path\_to\_img1 - path\_to\_img2 - **downloads** - path\_to\_file1 - path\_to\_file2 - **pages** Subpages to be published. - **...** same structure as for pages Config example ~~~~~~~~~~~~~~ :: version: 2 url: https://confluence.atlassian.com base_dir: docs/build/json pages: - attachments: downloads: - check_required_keywords.sh id: 49807825 source: part_1/newcomers watermark: <b>Automatic Publish</b> link: https://github.com/pet-project/doc.rst - id: 49807842 pages: - id: 49807843 source: part_1/development/start - id: 49807844 source: part_1/development/structure - id: 49807845 source: part_1/development/documentation - id: 49807846 source: part_1/development/logs source: part_1/development/index - attachments: downloads: - release.sh id: 49807847 source: part_1/release - id: 49807848 source: part_1/deployment - id: 49807849 source: part_1/tools - id: 49807850 source: part_1/plans - attachments: images: - 38-aval_1.jpg - 38-aval_2.jpg id: 49807851 source: part_2/availability or more JSONify style: :: { version: 2, base_dir: "result", pages: [ { id: 52136662, source: "release_history" } ] } .. |Build Status| image:: https://travis-ci.org/Arello-Mobile/confluence-publisher.svg?branch=master :target: https://travis-ci.org/Arello-Mobile/confluence-publisher

نیازمندی

مقدار	نام
>=1.2.1	argparse
>=3.11	PyYAML
>=2.4.3	requests

نحوه نصب

نصب پکیج whl confluence-publisher-1.2.1:

pip install confluence-publisher-1.2.1.whl

نصب پکیج tar.gz confluence-publisher-1.2.1:

pip install confluence-publisher-1.2.1.tar.gz