Skip to main content

reStructuredText to confluence/jira markup converter

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for rst2jira, version 0.7.1
Filename, size File type Python version Upload date Hashes
Filename, size rst2jira-0.7.1-py3-none-any.whl (8.5 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page