c6e73e0892
Co-authored-by: Rajiv Aaron Manglani <rajiv@alum.mit.edu> |
||
|---|---|---|
| .. | ||
| assets | ||
| manual | ||
| spec | ||
| standalone | ||
| tutorial | ||
| README.md | ||
| 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 | ||
| request.md | ||
| response.md | ||
| running-tests.md | ||
| samples.md | ||
| templates.md | ||
README.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.
[!TIP] TLDR To update all docs:
$ bin/docs/update_all.sh
Documentation Generation
Some files are dependent and needs to be generated appropriated.
docs/spec/options/**/*.option: define the command line option ofhurlandhurlfmt. These are text declarative files that will update project files (Rust files to produce the output of--help, Rust file options etc..., shell completion script etc...). These files are also used to generate part of man filesdocs/manual/hurl.md,docs/manual/hurlfmt.mddocs/manual/hurl.md/docs/manual/hurlfmt.md: Markdown source files of man pageshurl.1``hurlfmt.1README.md/packages/hurl/README.md, /packages/hurlfmt/README.md: GitHub and https://crates.io READMEs. These files are entirely generated from previous files (.optionsfiles,.mdmanual)
Options
Hurl options files describes each option of hurl and hurlfmt. They're used to generated various files of the project.
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.1andhurlfmt.1 - to generate Markdown documentation page
manual.mdfor 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 to update manual and READMEs
- 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