Skip to main content

Convert reStructuredText to Confluence markup

This is cloned from https://github.com/netresearch/rst2confluence. See Changelog.

https://travis-ci.org/netresearch/rst2confluence.svg?branch=master

Supported directives

  • bullet list

  • enumerated list

  • image, figure, confluence image galleries

  • definition list (with classifiers)

  • simple and grid tables

  • block quote

  • text effect

    • strong

    • emphasis

    • monospace

  • code blocks

  • links

  • admonitions

    • info

    • note

    • tip

    • warning

  • field lists

  • line blocks (except nested ones)

  • meta directives

  • substitutions

Additional features

Excerpts

When using the command line option --excerpt, your confluence code will mark up the first paragraph as excerpt.

Image galleries

Images and figures with class names that begin with gallery- form a gallery:

.. image:: cat.jpg
    :class: gallery-1
.. image:: dog.jpg
    :class: gallery-1
.. figure:: horse.jpg
    :class: gallery-2
    :scale: 50%

This creates two galleries: One with cat and dog, the other one with the horse picture only. All attributes are ignored on gallery images.

Gallery-classed images are converted to {gallery:include=a.jpg,b.jpg} Confluence markup.

Usage

./rst2jira.py /path/to/file.rst

Installation

From git checkout:

$ sudo ./setup.py install

Without a git checkout from the Python Package Index:

$ pip install rst2jira

Dependencies

  • colordiff (for running the tests)

Tests

We have some examples how rst2jira should behave.

Check if it does what it should:

./run-tests.sh

Run a single test:

./run-test.sh test/figure.rst

Metadata

Release files for rst2jira 0.7.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for rst2jira 0.7.1
File Interpreter ABI Platform
rst2jira-0.7.1-py3-none-any.whl Python 3 none any Details

Release files / rst2jira-0.7.1-py3-none-any.whl

Download URL rst2jira-0.7.1-py3-none-any.whl
Size 8.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d3b4b98045292c8e086c108e958a705af331a2d309121a63a116eb271f0c7709
BLAKE2b-256 checksum
How to use checksums
d6b7876e02279fcb870d17329592e114138ffdeac7405a81b69dd5d39ee08293
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.0.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.8.2

Release history Release notifications | RSS feed

This release

0.7.1 This release

1 release file

0.7.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page