Skip to main content

Supported directives

  • bullet list

  • enumerated list

  • image, figure, confluence image galleries

  • definition list

  • 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

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

./rst2confluence.py /path/to/file.rst

Installation

sudo ./setup.py install

Dependencies

  • python-docutils

Tests

We have some examples how rst2confluence should behave.

Check if it does what it should:

./run-tests.sh

Run a single test:

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

Other tools

Use deploy-rst to automatically deploy rST documents into confluence.

Download files

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

Source Distribution

rst2confluence-0.5.0.tar.gz (5.5 kB view details)

Uploaded Source

File details

Details for the file rst2confluence-0.5.0.tar.gz.

File metadata

File hashes

Hashes for rst2confluence-0.5.0.tar.gz
Algorithm Hash digest
SHA256 a240f9a1e2b18ea2d985b1d6eb319ae9280c99e409a98643820d1a2d51c24fd4
MD5 5cbc7d601f9bd86c063a426d1e3d204a
BLAKE2b-256 531437a4534f4341627298413d2d3222cc8680690f0426b8480a215f0bc14878

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page