https://github.com/netresearch/deploy-rst
Deploy a reStructuredText document into a wiki, e.g. confluence
https://github.com/netresearch/deploy-rst
php restructuredtext
Last synced: 11 months ago
JSON representation
Deploy a reStructuredText document into a wiki, e.g. confluence
- Host: GitHub
- URL: https://github.com/netresearch/deploy-rst
- Owner: netresearch
- Created: 2011-12-29T15:53:58.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2025-02-18T12:48:47.000Z (over 1 year ago)
- Last Synced: 2025-04-03T19:09:35.502Z (about 1 year ago)
- Topics: php, restructuredtext
- Language: PHP
- Homepage:
- Size: 51.8 KB
- Stars: 9
- Watchers: 14
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: ChangeLog
Awesome Lists containing this project
README
**********
deploy-rst
**********
Deploys a ``README.rst`` file into a wiki, e.g. Confluence
.. meta::
:deploy-target: confluence
:confluence-host: http://confluence.example.org
:confluence-space: IT
:confluence-page: rstpagetest
============
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
============
* rst2confluence__
* `Confluence Command line interface`__
* ``System`` from PEAR
* ``Console_CommandLine`` from PEAR
__ https://github.com/netresearch/rst2confluence
__ https://bobswift.atlassian.net/wiki/display/CSOAP/Confluence+Command+Line+Interface