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

From git checkout:

$ sudo ./setup.py install

Without a git checkout:

$ pip install rst2confluence

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.

Releasing a new version

  1. Fill ChangeLog

  2. Update version in setup.py

  3. Create release tag

  4. Upload to pip:

    $ ./setup.py sdist upload

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.1.tar.gz (5.6 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for rst2confluence-0.5.1.tar.gz
Algorithm Hash digest
SHA256 8cde56503a4dff8360e322c60084b5984e51e8fccc9ffd455c2fc9cbd17fb155
MD5 6da250d4140f7d151e69106ef5ea039d
BLAKE2b-256 55057c2e19c94accfa4db5320255c6731b0d0b033ad897f2883823b97782b948

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