Orange-OpenSource/hurl
1
1
Fork 0
mirror of https://github.com/Orange-OpenSource/hurl.git synced 2024-12-22 18:41:33 +03:00
Code Issues Packages Projects Releases Wiki Activity
989603c545
hurl/docs/README.md
jcamiel 948f1e2065
Rename manual-page.md to manual.md
2022-09-02 15:39:24 +02:00

2.0 KiB
Raw Blame History

Hurl Documentation

This directory is the canonical source for Hurl documentation. The site https://hurl.dev, powered by Jekyll, is generated from it. If you want to modify https://hurl.dev, you can make a PR in this repo.

Manual Page

The canonical source for the Hurl manual pages is at https://github.com/Orange-OpenSource/hurl/tree/master/docs/manual. The markdown files hurl.md and hurlfmt.md are used :

Dependencies:

docs/manual/hurl.md => docs/manual/hurl.1
docs/manual/hurl.md => docs/manual.md

docs/manual/hurlfmt.md => docs/manual/hurlfmt.1

READMEs

GitHub README and crates.io README are generated from the canonical docs.

Dependencies:

docs/*.md => README.md
docs/*.md => packages/hurl/README.md

Scripts

  1. generate manual
  2. generate <hurl.dev> manual
  3. generate GitHub README
  4. generate crates.io README
$ python3 bin/release/gen_manpage.py docs/manual/hurl.md > docs/manual/hurl.1
$ python3 bin/release/gen_manpage.py docs/manual/hurlfmt.md > docs/manual/hurlfmt.1
$ python3 bin/docs/build_man_md.py docs/manual/hurl.md > docs/manual.md
$ python3 bin/docs/build_readme.py github > README.md
$ python3 bin/docs/build_readme.py crates > packages/hurl/README.md