mirror of
https://github.com/Orange-OpenSource/hurl.git
synced 2024-08-17 01:20:41 +03:00
.. | ||
assets | ||
manual | ||
spec | ||
tutorial | ||
asserting-response.md | ||
capturing-response.md | ||
entry.md | ||
filters.md | ||
frequently-asked-questions.md | ||
grammar.md | ||
home.md | ||
hurl-file.md | ||
index.md | ||
installation.md | ||
license.md | ||
manual.md | ||
README.md | ||
request.md | ||
response.md | ||
running-tests.md | ||
samples.md | ||
templates.md |
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 :
- to generate manual pages
hurl.1
andhurlfmt.1
- to generate Markdown documentation page
manual.md
for https://hurl.dev
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
- generate manual
- generate <hurl.dev> manual
- generate GitHub README
- generate crates.io README
$ cd ..
$ 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