netresearch/deploy-rst

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

Maintainers

Details

github.com/netresearch/deploy-rst

Homepage

Source

Issues

Installs: 21

Dependents: 0

Suggesters: 0

Security: 0

Stars: 9

Watchers: 15

Forks: 2

v1.0.0 2016-12-28 13:16 UTC

Requires

AGPL 3 2ccf2a9423c5500ff8624b487cf4387795a28e45

  • Christian Weiske <christian.weiske.woop@netresearch.de>

wikirstreStructuredText

This package is auto-updated.

Last update: 2024-12-14 03:33:54 UTC

README

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