Permalink
Fetching contributors…
Cannot retrieve contributors at this time
73 lines (52 sloc) 1.49 KB

deploy-rst

Deploys a README.rst file into a wiki, e.g. Confluence

Installation

$ pear channel-discover pear.nrdev.de
$ pear install nr/deployrst-alpha

Setup

$ cp `pear config-get cfg_dir`/DeployRst/config.php.dist ~/.config/deploy-rst
$ emacs ~/.config/deploy-rst
.. change user and password

Meta data in rST files

It is possible to embed wiki target meta data in the .rst files directly, so that you don't have to pass all parameters via command line.

Example:

.. meta::
   :deploy-target: confluence
   :confluence-host: http://confluence.example.org
   :confluence-space: IT
   :confluence-page: rstpagetest

Usage

Deployment with meta data in the .rst file:

$ ./deploy-rst.php README.rst

Without embedded meta data:

$ deploy-rst --driver=confluence --confluence-host=http://confluence.example.org\
  --confluence-space=IT --confluence-page=rstpagetest README.rst

Help:

$ ./deploy-rst.php --help

Dependencies