packit / tmt-plans

Shared library of TMT plans
MIT License
0 stars 3 forks source link

Add a documentaiton system #3

Open LecrisUT opened 1 year ago

LecrisUT commented 1 year ago

For now the format would be plain markdown so that it is imported in packit.dev documentation. Template format is inspired from cmake's documentation:

# Title

<!-- SPHINX-START -->

Short description

## Synopsis

plans: import: url: https://github.com/packit/tmt-plans ref: main name: /plans/name-of-plan


## Options

`NAME_OF_ENV_INPUT` [Default: `some_value`]
  Details about option

## Examples

## See Also

<!-- SPHINX-END -->