var ➡️ reStructuredText#

Replace substitutions in rst file with variables.

Quickstart#

Installation#

To install varST, run this command.

$ pip install varst

Usage#

$ varst [-i INPUT] [-o OUTPUT] [substitutions ...]

# run with default input and output
$ varst 'name=value'

# run with custom input and output
$ varst -i input.rst -o output.rst 'name=value'

# run with multiple substitutions
$ varst 'name1=value1' 'name2=value2'

Directive Type#

Github Actions#

varST can be integrated with Github Actions. Please refer to this link and apply it to your own workflows.

API documentation#

Changelog#

Indices and tables#