Skip to main content

Tool to push reST docs to confluence

Project description

rst2wiki is command line utility for pushing your documentation in reStructuredText format to Confluence wiki. Under the covers it uses rst2confluence library for transforming ReST files and pushes result using Confluence REST API.

Installation

It is available through PyPI:

pip install rst2wiki

or getting more popular recently:

python -m pip install rst2wiki

Personally, I recommend to use pipsi:

pipsi install rst2wiki

Usage

Due to limitations of current Confluence REST API, you need to make a placeholder page beforehand and get its page id. For better user experience you need also to get ancestor page id (or result page will move to space’s root after update). Then, you can use it as follows:

rst2wiki --page 10814244 --ancestor 1147842 README.rst

First time it will ask you for some configuration values: Confluence url (don’t forget https:// part), your login and password and store it for further usage.

There are some more options: --warning (adds warning to top of your page that this page is autogenerated and manual revisions will be overwritten), --title to specify page title in confluence (use exiting, if not specified) and --config for configuration file location.

More interesting, it is possible to embed all arguments (except config) to ReST document by adding comment like this:

.. rst2wiki

  :page: 10814244
  :ancestor: 1147842
  :title: README
  :warning: en

After that you can use tool as follows:

rst2wiki README.rst

Of course, you still can override metadata in document in command line:

rst2wiki --warning off README.rst

Project details


Download files

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

Source Distribution

rst2wiki-0.2.0.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

rst2wiki-0.2.0-py2-none-any.whl (5.2 kB view details)

Uploaded Python 2

File details

Details for the file rst2wiki-0.2.0.tar.gz.

File metadata

  • Download URL: rst2wiki-0.2.0.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for rst2wiki-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ef1fca7fe3b72e1ad79f5cd069247a3c382711e55d0f56335a73a0664e1d1e57
MD5 1a5f8fa00bf32d9dd4d9051486fde92c
BLAKE2b-256 7ddeb9eecad8dd37aab745a0443cc96b13184f09aa58deeb7bb791fd6b08750c

See more details on using hashes here.

File details

Details for the file rst2wiki-0.2.0-py2-none-any.whl.

File metadata

File hashes

Hashes for rst2wiki-0.2.0-py2-none-any.whl
Algorithm Hash digest
SHA256 d1eb7ef46d7020da6c9f7e59b399c6fbb5436d559463904ab1af2d67d0b95076
MD5 b8dc3e0cf76049241c6d631bdf2afdcd
BLAKE2b-256 403a8552b887813b2897cfb1ea77cf9eb7b6b87dd1f9b60fcece6b4672c4ce18

See more details on using hashes here.

Supported by

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